`claude plugin validate --strict` auto-discovers every .md under a plugin's agents/ directory as an agent requiring frontmatter, so the provenance file there always needs fake agent frontmatter to pass validation. Confirmed empirically that an explicit `agents` manifest array can't suppress this discovery. Move the file to <plugin-root>/ sources.md instead, and update agent-author/agent-audit accordingly. Adds ADR-0010, partially superseding ADR-0005's `agents/sources.md` convention. Fixes #63. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
47 lines
2.9 KiB
Markdown
47 lines
2.9 KiB
Markdown
# agent-author generates both provider files from a single root input
|
|
|
|
`agent-author` is the skill that creates Claude Code and GitHub Copilot CLI agent
|
|
definition files. Both providers are always targeted: Claude Code produces a `.md`
|
|
file; Copilot CLI produces a `.agent.md` file. The scaffold script `new-agent.sh`
|
|
accepts a single root directory and derives both destination paths by convention
|
|
rather than requiring the caller to supply two explicit paths. Scope is detected
|
|
from the root: a directory containing `plugin.json` is plugin scope (both files
|
|
land in `<root>/agents/`); a directory with `.git` but no `plugin.json` is project
|
|
scope (`.claude/agents/<name>.md` + `.github/agents/<name>.agent.md`); `~` is user
|
|
scope (`~/.claude/agents/<name>.md` + `~/.copilot/agents/<name>.agent.md`).
|
|
|
|
## Considered options
|
|
|
|
**Two explicit destination paths (rejected)** — `new-agent.sh <name> <claude-dest>
|
|
<copilot-dest>` accepts a separate path per provider. Rejected because it breaks
|
|
the minimal-input principle that guides the entire skill: the caller must now know
|
|
and supply two provider-specific paths, which is exactly the convention knowledge
|
|
the script is meant to encapsulate. Every invocation becomes more error-prone and
|
|
harder to drive from a skill body without user interaction.
|
|
|
|
**Plugin-only dual generation (rejected)** — generate both files only at plugin
|
|
scope; at project/user scope generate a single file with the provider inferred from
|
|
the destination path. Rejected because it is an artificial asymmetry: the reason to
|
|
author for both providers does not disappear outside a plugin context. It would
|
|
force users to run the skill twice per agent at project/user scope or build a
|
|
separate single-provider skill, adding complexity with no benefit.
|
|
|
|
## Consequences
|
|
|
|
- `.github/agents/` is the locked-in Copilot CLI convention at project scope.
|
|
Non-standard paths (e.g. `.copilot/agents/`) are not supported without an
|
|
explicit override flag — deferred to a follow-on issue.
|
|
- The script interface `new-agent.sh <name> <root>` is a stable public contract.
|
|
Changing to a two-destination form is a breaking change to any caller.
|
|
- At plugin scope, both files share a single `agents/sources.md` for provenance.
|
|
At project/user scope, no sources file is generated — ad-hoc authoring outside a
|
|
research-driven workflow has no provenance chain to record.
|
|
- The file-by-file no-op in the script (skip existing files rather than
|
|
overwriting) means partial state — one provider file exists, the other does not —
|
|
is handled by routing in the skill body, not in the script.
|
|
|
|
**Update (ADR-0010):** the `agents/sources.md` path above is superseded. The provenance
|
|
file now lives at `<plugin-root>/sources.md`, outside the `agents/` directory, because
|
|
`claude plugin validate --strict` auto-discovers every `.md` under `agents/` as an agent
|
|
requiring frontmatter. See ADR-0010 for the empirical finding and rationale.
|