Repository navigation
docs(ai): improve agent-facing llms.txt and Markdown exports - #551
Conversation
Add a site description and agent instructions, describe pages that were listed without one, drop empty nav stubs from the index, list Relay's non-EVM chains on Supported Chains, and document the Relay MCP server. Amp-Thread-ID: https://ampcode.com/threads/T-01a1b1ba-012a-756d-8c12-aa51ef7e17f0 Co-authored-by: Amp <amp@ampcode.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Claude finished @pedromcunha-uneven's task in 41s —— View job Code review: PR #551
I found no correctness bugs in the diff. Every link target exists: 1. The new docs describe MCP tools that npm doesn't ship yet (fix before merge)
The new section says the server can "estimate fees", "check chain health" and track transactions, and it names The first Options:
2. Nit: Contract Audits points at a redirect
3. Nit: calling Hyperliquid "non-EVM" is only half right
Relay supports both HyperCore and HyperEVM ( Looks good
I didn't run |
[Medium impact] The PR appears safe to merge, with a non-blocking gap in the Supported Chains Markdown. Findings
|
Amp-Thread-ID: https://ampcode.com/threads/T-01a1b1ba-012a-756d-8c12-aa51ef7e17f0 Co-authored-by: Amp <amp@ampcode.com>
|
Claude finished @pedromcunha-uneven's task in 26s —— View job Re-review after
|
Amp-Thread-ID: https://ampcode.com/threads/T-01a1b1ba-012a-756d-8c12-aa51ef7e17f0 Co-authored-by: Amp <amp@ampcode.com>
|
Claude finished @pedromcunha-uneven's task in 32s —— View job Re-review after
|
| "markdown": { | ||
| "instructions": [ | ||
| "To quote bridges and swaps, look up chains and tokens, or track Relay transactions from an agent, use the Relay MCP server: `npx -y @relayprotocol/relay-mcp`. It is read-only and does not sign or broadcast transactions. Setup: https://docs.relay.link/resources/developing-with-ai.md", | ||
| "For Relay Protocol's trust model, security architecture, and audits, see https://docs.relay.link/references/protocol/security.md. For address screening, see https://docs.relay.link/security/transaction-screening.md." |
There was a problem hiding this comment.
Chain exports lose useful content
The latest changes remove the plain-text chain names and agents-only API links from Supported Chains, along with the global GET /chains instruction here. Chains returns nothing outside the browser, so agents reading that page's Markdown again get empty Mainnets and Testnets sections. The remaining instruction points them to a local MCP server instead of the live list.
Restore the page's chain summary and live API links. They do not need to appear on every page.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Agents ranking cross-chain services (see the 100-agent experiment in #data-general) mostly describe Relay as a fast, cheap EVM bridge, with no mention of security or agent tooling. Mintlify generates
llms.txtfromdocs.jsonand page frontmatter, and several of those inputs are empty:docs.jsonhas nodescription, sollms.txthas no summary line.docs.jsonhas nomarkdown.instructions, so there's no Agent Instructions block.@relayprotocol/relay-mcp, the MCP server agents use to get quotes.This PR doesn't add a custom
llms.txt. Mintlify still generates it.Changes / decisions to review
docs.jsondescription: the approved introduction from CLAUDE.md §1.2, verbatim. It becomes the summary line ofllms.txt.docs.jsonmarkdown.instructions: two lines, one pointing agents to the Relay MCP server and one to the protocol security and transaction screening pages. Mintlify adds this block tollms.txt,llms-full.txt, and every page's Markdown export, so it's kept short.urlnow points straight to/references/protocol/security, so it no longer goes through a redirect.noindex: trueon the empty Core, Utilities and Advanced stubs, which removes them fromllms.txtand the sitemap. They still create the sidebar group headers.@relayprotocol/relay-mcp0.4.0 is on npm (in progress, chore: bump server.json to 0.4.0 relay-mcp#12). The new section and the agent instruction describe 0.4.0's tools, andnpxstill installs 0.1.1. The version isn't pinned, so the docs won't break when later releases ship.Not in this PR
llms-full.txt) shows empty "Mainnets" and "Testnets" headings, and agents never see Bitcoin, Solana, Tron or TON. This needs a fix that keeps the table dynamic for users and generates the list for LLMs, so it goes in its own PR.mint validatefails onmainwith an existing<StatusWebsockets>error incalling-integration-guide.mdx, which this PR doesn't touch.Verification
mint dev: the.mdexport for Integrating using AI includes the Agent Instructions block and the new MCP section.llms.txton the Mintlify preview deployment shows the summary, the Agent Instructions block and the new descriptions, and no longer lists the empty stubs.