Skip to content

docs(#937): document agent definition frontmatter conventions - #939

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/937-doc-agent-frontmatter
Open

docs(#937): document agent definition frontmatter conventions#939
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/937-doc-agent-frontmatter

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Summary

  • Add section 8 to AGENTS.md documenting agent definition frontmatter fields (name, description, model, skills, tools) with syntax rules and examples
  • Document the tools: comma-space separator requirement and the parser bug that silently drops tool names when the space is omitted (root cause of the PR fix(#914): add Skill to triage and prioritize tools #917 → PR fix(#914): space before Skill in tools frontmatter #928 rework cycle)
  • Document the skills:/tools: interaction: when tools: restricts tool access, Skill must be included for skill access to work
  • Renumber former section 8 (harness env var literals) to section 9

Testing

  • Verified no cross-references to section numbers in AGENTS.md exist elsewhere in the codebase
  • Confirmed all fields documented match those used across existing agent definitions (agents/*.md)
  • Secret scan passed; gitlint passed

Closes #937

Post-script verification

  • Branch is not main/master (agent/937-doc-agent-frontmatter)
  • Secret scan passed (gitleaks — d021f80aea083fc3921b662b0b8534ff2433d09a..HEAD)
  • PR body secret scan passed (gitleaks — no-git)

Add section 8 to AGENTS.md documenting the YAML frontmatter fields
used in agent definitions (agents/*.md): name, description, model,
skills, and tools. The tools: field documentation emphasizes the
comma-space separator requirement — omitting the space causes the
parser to silently drop subsequent tool names, which caused the
incident in PR #917. The skills/tools interaction (skills: requires
Skill in tools: when tools: is present) is also documented.

Renumber the former section 8 (harness env var literals) to section 9.

Closes #937
@fullsend-ai-coder
fullsend-ai-coder Bot requested a review from a team as a code owner August 22, 2026 19:11
@fullsend-ai-review

fullsend-ai-review Bot commented Aug 22, 2026

Copy link
Copy Markdown

🤖 Finished Review · ✅ Success · Started 7:13 PM UTC · Completed 7:26 PM UTC

Commit: 1e9a4f2 · View workflow run →

@fullsend-ai-review

Copy link
Copy Markdown

Review

Findings

Medium


Labels: PR adds documentation to AGENTS.md covering agent definition frontmatter conventions

@fullsend-ai-review fullsend-ai-review Bot added requires-manual-review Review requires human judgment documentation Improvements or additions to documentation labels Aug 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready-for-review requires-manual-review Review requires human judgment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document agent definition frontmatter conventions including tools: syntax

0 participants