Skip to content
ContractSpec
Start here

Core guide · Reference · 4 min read

Use the docs with coding agents

Give an agent a small, versioned source set and keep documentation lookup separate from action authority.

Source context

Source-guided · d58fa5b7

Repository links may require access. Source inspection is separate from a clean public-package installation.

AN INTERACTIVE READING MAP

Get the shape of this guide.

Move through the ideas, inspect their relationships, or make a focused reading path. The complete guide stays below.

READING SEQUENCE

Understand how the ideas connect

01 / READING POINT

Start with a focused context packet

Give the agent the task, selected package versions or source commit, the relevant guide, and the exact contract or runtime reference. A small coherent source set is easier to verify than the entire monorepo corpus.

Ask it to identify which behavior is declared, which code implements it and which host dependency supplies authority. This encourages it to preserve the same boundaries a human reviewer would inspect.

1 / 4

0 points in your packet

Start with a focused context packet

Give the agent the task, selected package versions or source commit, the relevant guide, and the exact contract or runtime reference. A small coherent source set is easier to verify than the entire monorepo corpus.

Ask it to identify which behavior is declared, which code implements it and which host dependency supplies authority. This encourages it to preserve the same boundaries a human reviewer would inspect.

Choose the smallest useful entry point

This documentation offers an area index, a complete package directory and a bounded agent overview for every package. Start with the overview, then read the relevant package manual or its README text. Package manuals are regenerated from the current workspace manifests and area curation is pinned to bcc79fcc; the MCP source discussed below retains its stated d58fa5b7 context.

The Copy agent overview control provides purpose, source identity, declared capabilities and a limited import selection, with links to deeper evidence. The README text and the complete manual record remain available when the task needs them. Package presence, a version string and a declared import do not establish registry availability or successful execution.

NeedEntry point in this reviewWhat to inspect
Orientation/llms.txtChoose a core guide, area or package
All packages/docs/packagesExact package identity, layer and guide availability
One package, bounded context/llms/[slug]The package README as plain text
Full package evidence/docs/packages/[slug]README, capabilities, targets, dependencies and scripts
Area relationships/docs/areasEntry points and related technical areas

Understand the lookup tools

The inspected authoring MCP source defines documentation search, get, route resolution, contract lookup and facet listing. These are documentation operations. Their presence in source is not a claim that a public hosted MCP endpoint has been qualified.

Documentation lookup does not authorize editing a repository, executing a provider action or deploying an application. Keep the agent's work permissions separate from the information it can read.

A plugin, MCP server or skill should retrieve the same versioned documentation records and keep task instructions separate from retrieved evidence. This static review supplies the web, Markdown and JSON projections; the proposed shared DocSpec compiler and retrieval service are described in the DocSpec architecture review. It does not expose a new MCP endpoint or install a coding-agent skill.

Review the generated answer

Require links to the exact sources behind proposed APIs or commands. Check that examples use the same release channel, and ask for an explicit statement when a snippet is illustrative rather than executed.

For an implementation task, verify the result through the owning source checks and a meaningful runtime case. A confident answer that quotes documentation is still a proposal until the relevant behavior is tested.

Give an agent a coherent slice of the system.

An agent is asked to change one operation. A useful context packet keeps the task, source identity and execution responsibilities together.

What does the agent need to do?

A CONCRETE SITUATION

Start with orientation and a bounded reference.

The task names a capability but not the package that owns it.

01 / Orient

Read the relevant area and task context.

What changes

An area overview and package overview narrow the source set.

What stays explicit

A package listing does not establish registry availability or permission to edit it.

Follow the consequence

Choose the relevant package and source identity, then follow the exact manual or structured source data.

Use the docs with coding agents ↗

An authored situation, grounded in the linked source guides. Choosing a case explores its expected responsibilities; it does not execute an operation.