Skip to main content
Glama

project_docs

Read-onlyIdempotent

Readable documentation for the deployed project. Returns deterministic docs generated from the exact deployed source, plus routes, symbols, data tables, dependency graph, coverage flags, and a Mermaid map. It is the starting read for an unfamiliar project.

By default the document describes the project's active release (a successful default answer carries version_source: 'active_release', release_id and source_manifest_hash); version selects an exact older one, which carries version_source: 'explicit' and no release metadata. The deterministic document is available shortly after a successful deploy. Docs are generated without a model call. Existing projects receive docs on their next deploy and are not backfilled.

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": "project_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
versionNoOptional deploy version; defaults to the current live deploy sidecar.
project_idYesProject ID (UUID), subdomain, or slug — resolved server-side.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond readOnlyHint/idempotentHint the description discloses that docs are deterministic and generated without a model call, that they appear shortly after a successful deploy, and that existing projects are not backfilled. It also explains the version_source/release_id/source_manifest_hash contract for default versus explicit version reads — exactly the behavioral context annotations cannot convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose is front-loaded in a bolded lead sentence, followed by return contents, then versioning and freshness notes in a tight second paragraph. The parenthetical metadata enumeration is dense but each clause carries distinct information; no filler sentences.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description compensates by listing the returned sections and the identifying fields a caller should expect. It also covers the freshness caveat and the non-backfill condition, leaving nothing an agent needs in order to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3, but the description adds meaning the schema lacks: the default read targets the active release and returns release metadata, while an explicit `version` yields version_source 'explicit' with no release metadata. That changes how an agent should interpret results, not just how to fill a field.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The bolded lead states a specific verb and resource ('Readable documentation for the deployed project') and enumerates the payload (routes, symbols, data tables, dependency graph, coverage flags, Mermaid map). It does not, however, distinguish itself from the sibling tools named 'docs' and 'docs_query', so an agent must still infer the split.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'It is the starting read for an unfamiliar project' gives a clear situational trigger, and the second paragraph explains when to pass `version` versus relying on the default active release. It stops short of naming an alternative or stating when NOT to use this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources