Skip to content
RustUse

Using AI

RustUse is documented for humans first, but its documentation is also structured for AI-assisted development.

The llms.txt, llms-full.txt, per-facade text files, per-crate text files, and RustUse MCP Server provide progressively more structured ways for assistants and coding tools to understand the RustUse catalog.

This section explains which surface to use when you want an assistant, coding tool, local agent, or MCP-capable client to work with RustUse without manually pasting large chunks of documentation.

Access modes

Section titled “Access modes”
Mode Status Use it for
/llms.txt Live Quick RustUse orientation, routing, and facade discovery.
/llms-full.txt Live Broad project context when a tool can ingest a larger Markdown bundle.
/facades/{facade}/llms.txt Live Focused facade-level discovery through the /facades/ route shape.
/{facade}/llms.txt Live Canonical short facade-level discovery for a RustUse facade.
/crates/{crate}/llms.txt Planned Focused child-crate context once crate-level text files are generated.
RustUse MCP Server Planned and experimental Structured catalog access from MCP-capable clients.

Decision guide

Section titled “Decision guide”
Need a quick map of RustUse? Use /llms.txt
Need all public docs in one file? Use /llms-full.txt
Need only one facade? Use /facades/{facade}/llms.txt
Need only one child crate? Planned: use /crates/{crate}/llms.txt
Using an MCP-capable client? Planned: use the RustUse MCP Server

For current child-crate work, start with the facade-level file that owns the crate, then verify against the crate page and Rustdocs. For example, use /facades/use-math/llms.txt when working with use-prime today.

How the surfaces fit together

Section titled “How the surfaces fit together”

Use the root files when a tool needs to understand RustUse as a whole. They are best for project orientation, route discovery, and deciding which facade or crate is relevant.

Use facade-level files when the work is already inside one RustUse domain. They keep the prompt smaller while preserving the facade crate, child-crate list, repository, and Rustdoc routes for that facade.

Use planned crate-level files when they become available and the task is about one focused child crate. Until then, combine the owning facade’s LLM text file with the crate page and Rustdocs.

Use the planned RustUse MCP Server when your client supports Model Context Protocol and you want structured lookup instead of manually choosing text files.

In this section

Section titled “In this section”
  • LLM text files documents the current root and facade-level text file conventions plus planned crate-level files.
  • RustUse MCP Server describes the planned read-only MCP resource, tool, and prompt surface.
  • AI usage recipes provides copy/paste prompts for common assistant workflows.
  • Reference summarizes the URL and MCP URI patterns.