feat(llms): serve an /AGENTS.md agent guide - #85
Merged
Conversation
Add a /AGENTS.md route that serves the shared AGENT_INSTRUCTIONS block (install, auth config, and usage code) as markdown with the llms.txt index pointer prepended. This satisfies the AGENTS.md convention and Vercel's agent-readability check; until now /AGENTS.md 404'd. The markdown-negotiation middleware previously rewrote /AGENTS.md to /llms.mdx/AGENTS (stripping the .md suffix), so /AGENTS and /AGENTS.md are now excluded from negotiation to let the route handler own the request. A /.well-known/agents.md -> /AGENTS.md permanent redirect covers the alternate location, mirroring the existing llms.txt one.
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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
Final slice of the agent-docs effort. Adds a `/AGENTS.md` route serving the shared `AGENT_INSTRUCTIONS` block (install, auth config, usage code) as markdown with the `llms.txt` index pointer prepended. `/AGENTS.md` previously 404'd; this satisfies the AGENTS.md convention and Vercel's agent-readability check.
The non-obvious part: the markdown-negotiation middleware was already intercepting `/AGENTS.md` — its `.md`-suffix handler stripped the suffix to `/AGENTS`, found it negotiable, and rewrote the request to `/llms.mdx/AGENTS` (404). So `/AGENTS` and `/AGENTS.md` are added to `EXCLUDED_EXACT_PATHS` to let the route handler own the request. A `/.well-known/agents.md` -> `/AGENTS.md` permanent redirect covers the spec's alternate location (mirroring the existing `/.well-known/llms.txt` redirect).
Reuses `AGENT_INSTRUCTIONS` (`lib/agent-instructions.ts`) and `LLMS_INDEX_POINTER` (`lib/get-llm-text.ts`) — no new content.
Testing
This completes the agent-docs roadmap (.md suffix #81, index pointer #82, markdown cleanup #83, index hygiene #84, /AGENTS.md here).