docs: add AGENTS.md and agent discoverability layer#27
Merged
bradleygauthier merged 1 commit intomainfrom Apr 17, 2026
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
AGENTS.mdto the Capsule Protocol repo and upgrades the README with an agent-discoverability layer.AGENTS.md, and a new## Explore the fit with your AI coding agentH2 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
#explore-the-fit-with-your-ai-coding-agent)AGENTS.mdrenders with all 7 sections intactgrep -c "—" AGENTS.md README.md | grep -v "^0$"returns no matches in new content)cd reference/python && make test-all)