llms.txt, llms-full.txt, skill.md, and an MCP server, and the CLI can score agent readiness for a public site.
Local docs structure
This repo keeps the public docs site indoc/, with source pages in MDX, explicit frontmatter, and navigation in doc/docs.json.
Agent usefulness
Eyra docs should stay useful to both people and agents:- Put the operational contract in reference pages, not hidden prose.
- Keep settings, commands, tools, routes, and verification commands in tables.
- Link architecture pages to source files through Source map.
- Keep privacy boundaries explicit on every optional remote path.
- Avoid copying private prompt/spec/control-plane files into public docs.
Generated AI files
When hosted on Mintlify, the public documentation site can expose:| Path | Purpose |
|---|---|
/llms.txt | Directory of documentation pages with descriptions |
/.well-known/llms.txt | Compatibility path for the same index |
/llms-full.txt | Full documentation content for larger-context tools |
/.well-known/llms-full.txt | Compatibility path for the full file |
/skill.md | Capability summary generated from the docs |
/.well-known/agent-skills/index.json | Agent-skills discovery manifest |
/.well-known/agent-skills/* | Individual skill files |
/mcp | Documentation MCP server on hosted docs |
llms.txt summary uses the description field in docs.json, and each page entry uses the page frontmatter description.
Mintlify checks
Validate locally:mint@4.2.565 rejects Node 25+.
Preview locally:
Hosted Checks
When a hosted docs site exists, score it with:mint score checks agent-facing surfaces such as llms.txt, llms-full.txt, Markdown content negotiation, skill.md, MCP discoverability, sitemap, structured data, robots, and latency.
Current repo boundary
This repo contains the Mintlify source site and a static GitHub Pages deployment. Hosted AI-native artifacts such as livellms.txt, llms-full.txt, skill.md, and the documentation MCP server are available only after a separate hosted docs deployment is configured.