LLM Documentation
Give AI agents access to Sui SDK documentation in your project.
Every @mysten/* package ships a docs/ directory containing flat markdown files optimized for AI
agent consumption. When you install an SDK package, you automatically get accurate, up-to-date
documentation that coding agents (Claude Code, Cursor, Copilot, and others) can read directly. No
separate install or training data is required.
How it works
Each package includes:
docs/llms-index.md: Routing index listing all doc pages with descriptionsdocs/*.md: Individual reference pages
For example, installing @mysten/sui gives you docs at
node_modules/@mysten/sui/docs/llms-index.md.
Configure your agent
Add the following snippet to your agent's configuration file (AGENTS.md, CLAUDE.md,
.cursorrules, and others):
## Sui SDK reference
Every @mysten/\* package ships LLM documentation in its `docs/` directory. When working with these
packages, find the relevant docs by looking for `docs/llms-index.md` files inside
`node_modules/@mysten/\*/`. Read the index first to find the page you need, then read that page for
details.