docs_query
Query the source truth of a project — routes, symbols+doc-comments, import graph (depends-on/used-by), tables, task refs, coverage, and bounded rich route contracts — assembled from the source of the project's ACTIVE release. It answers questions about a project without grepping files.
By default the platform selects the sidecar of the exact active release (its ready, same-project version); there is no fallback to a newer or older sidecar. A successful default answer carries version_source: 'active_release', release_id and source_manifest_hash as selection metadata — what was selected, not independent certification of the artifact bytes. version selects an exact older sidecar; that answer carries version_source: 'explicit' and no release metadata. When the active release cannot be resolved (none active, not found, not ready, its source missing or temporarily unavailable) the answer is a neutral release-status error with version_source: 'active_release' and the release_id where one exists — no source hash, and never a claim that you must redeploy. A project whose selected release has no sidecar answers DOCS_SIDECAR_NOT_FOUND (404). Input problems are ordinary validation or project-not-found errors.
The result comes from the deploy-version-keyed docs sidecar selected for that release, not from a live grep. path, symbol, or route returns the matching methods/query actions, schema columns and constraints, sw.* and environment-name bindings (never values), and imported-helper evidence. The response never includes the whole readable Markdown document. If a sidecar is partial or omitted files, the response includes source hash/version/completeness flags so absence is not mistaken for proof that code is not deployed. The private canonical platform artifact is explicitly SOURCE truth, not serving/runtime-effective truth.
Examples:
{ "project_id": "my-saas" }
{ "project_id": "my-saas", "path": "api/checkout.ts" }
{ "project_id": "my-saas", "symbol": "createCheckout" }
{ "project_id": "my-saas", "route": "POST /api/checkout" }Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_id": "<project_id>"
},
"name": "docs_query"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Optional — exact deployed source path, e.g. api/checkout.ts or src/App.tsx. | |
| route | No | Optional — route path or METHOD + path, e.g. /api/checkout or POST /api/checkout. | |
| symbol | No | Optional — exported symbol name to find, including its doc comment and file. | |
| version | No | Optional — pins a specific deploy version. Defaults to the current live deploy sidecar. | |
| project_id | Yes | Project ID (UUID), subdomain, or slug — resolved server-side, no UUID lookup needed. |