Files
holocron/plugins/kyberforge/.apm/skills/agent-author/references/contract.md
Defame1297 54d7bd80ba docs: rule host built-ins out of the routing target universe
Closes the second open design decision on PR #103. The `/compact` finding was
recorded as a false positive needing an allowlist or a suppression mechanism.
It is neither: the routing universe is the apm marketplace, so a target either
resolves to a skill or an agent or it does not resolve, and `/compact`,
`/clear` and `/init` are Claude Code slash commands with no counterpart in
Copilot CLI or Codex. `.apm/` source compiles for all three, so a
vendor-neutral description routing to one is a portability defect and the hard
FAIL is a true positive.

An allowlist was rejected for a concrete reason, not a stylistic one: it
answers a different question ("does this exist on some host?"), it cannot
answer that portably from a single source file, and it goes stale the next
time a host ships a command — reintroducing the same-commit-two-verdicts
failure ADR-0020 already closed for deployed trees.

Nothing is blocked today: zero of the 43 descriptions name a host built-in,
and an author who needs to mention one writes it un-slashed, which is not
route notation and carries no routing claim.

Recorded in ADR-0020 and in both author-facing contract references, so the
next agent reads the decision rather than "fixing" the gate.

ADR: 0020

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-16 20:45:19 +00:00

8.0 KiB

source_keys
source_keys
claude-code-subagents-docs
github-custom-agents-configuration

The agent description and body contract

House contract, set by ADR-0020. The counts and the boundary targets are enforced by agent-audit's scripts/validate.sh; the prose patterns by the Vale styles it bundles; the judgment calls by its reference files.

Why the budget exists

An agent's name and description is loaded into every session's context at startup, whether or not the agent is ever delegated to — the same cost a skill's description carries, so agents take the same numbers. The body is different: it is not loaded into the caller's conversation at all, it becomes the system prompt of a fresh context when the agent runs. That is why the body has no word gate here and a skill body has one.

Description

A description carries exactly three things:

  1. Trigger clause — when to delegate, imperative: "Use when …", never "This agent …". Describe the user's intent and the triggering condition, not the agent's internal mechanics.
  2. At most one capability clause — what it does, one clause, no enumeration. Be specific ("reviews a diff for injected credentials", not "helps with security").
  3. Boundary clause — form: Not <thing> -> <name>. Add one only where a near-miss agent or skill could steal delegations.

Banned from a description; move it to the body or to README.md:

  • Capability enumeration or feature lists
  • Per-scope emission mechanics — which files the author skill writes at which scope changes no delegation decision
  • Output-format detail ("Produces a compact findings report with Why and Fix per finding")
  • Composition or architecture notes ("composes X rather than duplicating Y", "cross-cutting")
  • Implementation detail ("Self-validates via a bundled deterministic script")
  • Restating the same trigger twice in two registers — a verb list, then the same verbs re-quoted as user phrasings. This is a FAIL, not a suggestion.

Do not open with an action verb. "Reviews…", "Analyzes…", "Generates…" was the old house rule and ADR-0020 deleted it: the opener is Use when, matching every skill in this corpus, so one router reads one shape.

"Use proactively" is Claude Code-only, and conditional even there. The phrase steers the Claude Code runtime to offer an agent unprompted and does nothing anywhere else, so where it may appear depends on the file:

File Rule
Claude Code .md (project/user scope) Allowed. Add it only where the runtime should delegate without the user naming the agent — an agent invoked by name does not need it, and it costs activations elsewhere when added by reflex.
Copilot .agent.md (project/user scope) Never. Inert there, and KyberforgeCopilot.ProactivePhrase grades it a hard FAIL.
Vendor-neutral .apm/agents/<name>.agent.md (plugin/APM scope) Never. Same Vale rule, same hard FAIL — the file matches the **/*.agent.md glob, and it compiles to a real Copilot agent downstream.

A pair whose Claude Code half carries the phrase and whose Copilot half omits it is correct, not inconsistent: agent-audit checks that both halves describe the same job, not that they match word for word.

Indirect triggers ("even if the user doesn't say X") take a similar conditional at every scope: add one only where the user's natural phrasing genuinely omits the domain word.

Boundary targets must resolve. Both forms are checked — the arrow and the prose form ("do not use for X, use y instead") — so a typo dangles either way. Targets resolve against a universe built by walking up from the agent file itself: the nearest ancestor holding plugins/*/.apm/{skills,agents} (or, failing that, the nearest ancestor holding .git) contributes every skill and agent under <root>/plugins/*/, plus the agent's own apm package and the packages that package declares in apm.yml under dependencies.apm. A sibling plugin in the same monorepo therefore resolves; a skill in an unrelated repo does not. A target outside that universe sends the router nowhere. Verify it before writing it — do not invent a plausible sibling.

That universe is the apm marketplace and stops there. A host built-in is not a routing target: /compact, /clear and /init are Claude Code slash commands with no counterpart in Copilot CLI or Codex, and .apm/ source compiles for all three, so routing to one is a portability defect. The gate is right to fail it and there is no allowlist. If a built-in genuinely needs mentioning, write it un-slashed — the `compact` built-in — which makes no routing claim and is not checked.

Length. 250 characters SUGGESTION, 400 characters FAIL, counting the frontmatter value only with YAML folding resolved. Treat 250 as the target: the SUGGESTION tier is what moves the corpus average, the FAIL tier only stops outliers.

Body

Write the body as a direct role instruction, addressed to the agent:

You are a <role>. When invoked, <primary action>.

## Inputs
<what the agent is given: files, context, parameters>

## Process
<ordered steps; be explicit where ordering matters>

## Output
<what it produces: format, location, structure>

## Errors
<what to do on malformed, missing or contradictory input: report and stop, or
 which fallback to take — and what to say to the caller either way>

Four required elements: inputs expected, process steps, output format, error handling. The last is the one that gets dropped, and dropping it is not neutral: an agent given a malformed input and no instruction invents a recovery, and a subagent's invented recovery is invisible to the caller until the output is wrong. Say explicitly whether the agent stops and reports, or degrades to a named fallback.

One job per agent. An agent covering two jobs gets delegated to for the wrong one.

Delegation discipline replaces the word gate. A plugin/APM agent is a single file with no sibling references/ directory: it cannot disclose progressively to itself, so its only way to stay short is to invoke rather than restate. A body that transcribes a procedure a skill it can invoke already owns is an agent-audit FAIL, and the fix is one line — "invoke <skill>".

  • Restating: "To commit, check the message against Conventional Commits: type, scope, description; header under 100 chars; …"
  • Delegating: "Author commits with git-commits."

The same holds for a procedure another agent owns. What belongs in the body is what no invocable skill covers: the agent's role, its boundaries, the order it works in, and the format it returns.

State a read-only boundary in prose, not only in frontmatter. disallowedTools denies the tools it names and nothing else — never Bash, which an agent with no tools field inherits — so an agent fenced only in frontmatter can still write through a shell redirect.

Invocation axis

Decide before writing the description whether the agent is model-delegated (the runtime picks it) or reached only by name (@agent-<name>).

Only Copilot's cloud/IDE format expresses that in frontmatter: disable-model-invocation: true requires explicit invocation, and user-invocable: false hides an agent from manual invocation. Both live in .github/copilot/agents/<name>.md and are inert in the CLI format. Claude Code has no equivalent field, and neither does the vendor-neutral plugin/APM file, so at those scopes a name-invoked agent still needs a description precise enough not to steal delegations — the boundary clause is doing that work.

One gate, two measurements

Gate SUGGESTION FAIL Counts
description 250 chars 400 chars the description: value only
body (Copilot limit) 30,000 chars — the body only; content past it is truncated silently

The 30,000-character Copilot ceiling is a runtime truncation limit, not a quality target, and it applies to a plugin/APM file too — that file compiles into a real Copilot agent downstream. An agent body long enough to approach it has a delegation defect, not a length problem.