Skip to content

docs: add AGENTS.md and agent discoverability layer#27

Merged
bradleygauthier merged 1 commit intomainfrom
docs/agents-md
Apr 17, 2026
Merged

docs: add AGENTS.md and agent discoverability layer#27
bradleygauthier merged 1 commit intomainfrom
docs/agents-md

Conversation

@bradleygauthier
Copy link
Copy Markdown
Contributor

Summary

Adds AGENTS.md to the Capsule Protocol repo and upgrades the README with an agent-discoverability layer.

  • AGENTS.md: the convergent industry-standard agent context file (Linux Foundation AAIF stewardship, 60K+ repos, read natively by Codex, Cursor, Copilot, Aider, Zed, Amp). Covers commands, the multi-language repo layout, style rules, crypto allowlist, and the invariants that keep the protocol stable across languages (canonical JSON byte equality, 16 + 15 golden conformance vectors, air-gap compatibility).
  • README additions: AI Agents badge in the badge row, a blockquote callout pointing agents at AGENTS.md, and a new ## Explore the fit with your AI coding agent H2 section positioned right before ## Implementations. The section contains a sample prompt a reader can paste into their AI coding agent to survey their codebase for places that need tamper-evident audit coverage.

Part of the cross-repo rollout happening now across the Quantum Pipes ecosystem (vault, tunnel, conduit, core, hub, conductor, scout, wizard, create-qp-app, emergence, desktop, docs, capsule-go, capsule-litellm).

Test plan

  • README renders correctly on GitHub (badge row, callout, H2 section, anchor link #explore-the-fit-with-your-ai-coding-agent)
  • AGENTS.md renders with all 7 sections intact
  • No em dashes in either new file (grep -c "—" AGENTS.md README.md | grep -v "^0$" returns no matches in new content)
  • All existing conformance vectors still pass (cd reference/python && make test-all)

AGENTS.md is the convergent standard agent context file (Linux
Foundation AAIF stewardship, read natively by Codex, Cursor, Copilot,
Aider). A concise file covering commands, the multi-language repo
layout, style, crypto allowlist, boundaries, and the invariants that
keep the protocol stable across languages (canonical JSON byte
equality, conformance vectors, air-gap compatibility).

README gains an AI Agents badge, a callout pointing at AGENTS.md,
and a pre-Implementations "Explore the fit" H2 section with a sample
prompt inviting a reader's agent to find places in their codebase
that need tamper-evident audit coverage.
@bradleygauthier bradleygauthier merged commit b7591b6 into main Apr 17, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant