Skip to content

Add agent discovery metadata for docs - #122

Open
dimitri-circle wants to merge 2 commits into
thorchain:masterfrom
dimitri-circle:update/docs-agent-readiness
Open

dimitri-circle wants to merge 2 commits into
thorchain:masterfrom
dimitri-circle:update/docs-agent-readiness

Conversation

@dimitri-circle

Copy link
Copy Markdown

Summary

  • add truthful Auth.md, agent instructions, and a read-only documentation research skill
  • add a narrowly routed Cloudflare Worker for RFC 8288 Link headers, RFC 9727 API catalog, MCP server card, Agent Skills index, and ARD manifest
  • document the DNSSEC-validated DNS-AID SVCB record and rollback boundaries
  • add the two human-readable agent pages to GitBook navigation

OAuth, A2A, WebMCP, registration, and payment metadata remain absent because this public documentation service does not provide those capabilities.

Verification

  • node test suite: 9 of 9 passed
  • Cloudflare versioned Preview URL: public scanner Level 4, Agent-Integrated
  • production scanner after rollout: Level 4, with Link headers, DNS-AID, API catalog, MCP card, Agent Skills, and ARD passing
  • production homepage SHA-256 remained unchanged across the edge rollout
  • HTML and Markdown negotiation remained available
  • representative documentation routes and robots.txt remained available
  • live GitBook MCP initialize still returns protocol 2025-06-18 and the verified tool capability
  • published skill SHA-256 matches the served bytes
  • Cloudflare and Google DNS resolvers return AD=true for the DNS-AID record

Rollback

Remove only the four Worker routes declared in wrangler.jsonc and delete only the SVCB record declared in dns-aid-record.json. The GitBook CNAME is unchanged.

@GrassRootsCrypto

Copy link
Copy Markdown
Collaborator

Thanks for the careful rollout notes and the narrow Worker routes. One thing that is easy to miss from this GitHub tree: GitBook already publishes the agent-discovery surface on the live origin. Those files are generated at publish time, not checked into thorchain/docs, so they never show up in SUMMARY.md.

On https://docs.thorchain.org today (GitBook, not this Worker):

• Index: https://docs.thorchain.org/llms.txt
• Full dump: https://docs.thorchain.org/llms-full.txt
• Any page as markdown: append .md (e.g. https://docs.thorchain.org/readme.md)
• MCP: POST https://docs.thorchain.org/~gitbook/mcp (protocolVersion 2025-06-18, tools searchDocumentation / getPage / sendFeedback)

Adding llms.txt (or an equivalent catalog) to this repo would not replace that. GitBook serves those URLs from the custom domain regardless of git.

The Worker is already live in front of that origin. Homepage Link headers and /.well-known/* are useful signposts, but they mostly point at the GitBook URLs above. /AGENTS.md and /auth.md are Worker-only exact paths; GitBook’s lowercase /agents.md is currently its generic “page not found” markdown (HTTP 200), not a published page. After merge, GitBook would publish the git files at its own slugs while the Worker still owns the uppercase routes, so the two copies can diverge.

If the goal is “agents can find and read these docs,” GitBook’s /llms.txt + /~gitbook/mcp already do that. I’d treat the Worker catalogs / DNS-AID / root AGENTS.md as optional extras, and keep repo-root AGENTS.md for editing this GitBook repo (trunk, SUMMARY.md) rather than for the published site.

Happy to walk through live headers vs GitBook .md URLs if useful.

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.

3 participants