Skip to main content
Glama

read_project_document

Read-only

Read exact, bounded sections of SpecPlanner project documents and comments, including archived review context when available, to inspect content and history.

Instructions

Exact, bounded text of a library document. Follow text and comment continuations. Archived reviews are included when an archive receipt identifies the original change; otherwise review history is explicitly unknown.

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": {
      "path": "<path>"
    },
    "name": "read_project_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
limitNo
offsetNo
commentIdNo
commentFieldNo
commentsLimitNo
knownRevisionNo
workspacePathNoTrusted absolute project path from this chat; pass on every call. null selects personal storage. Omission uses only the environment default.
commentsCursorNo
expectedIdentityNo
expectedRevisionNo
knownCommentsRevisionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.5.1

TDQS

C2.8/5.0
Behavior3/5

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

Annotations already establish readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds real but terse behavior: bounded output with continuations, and the rule that archived reviews are only included when an archive receipt identifies the original change, otherwise review history is explicitly unknown. The concept of an "archive receipt" is left undefined, so the disclosure is directionally useful but hard to act on.

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

Conciseness3/5

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

Three sentences, front-loaded with the retrieval scope and no filler, which is appropriate. However, the sentences are compressed to the point of opacity ("Follow text and comment continuations", "archive receipt") and rely on terminology the agent must infer.

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

Completeness2/5

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

The tool has 12 parameters, 8% schema description coverage, no output schema, and concurrency/revision parameters (knownRevision, expectedRevision, expectedIdentity) whose effect is not described anywhere. The description covers scope and a review-history caveat, but leaves out pagination mechanics, comment selection, workspace scoping, and identity/revision behavior. It is not complete enough for an agent to call this correctly without guessing.

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

Parameters2/5

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

Schema description coverage is only 8% across 12 parameters, so the description carries the burden of explaining semantics and largely does not. "Bounded" faintly gestures at limit/offset and "comment continuations" at commentsCursor, but commentId, commentField, commentsLimit, knownRevision, expectedRevision, expectedIdentity, knownCommentsRevision and workspacePath are entirely unaddressed. For a 12-parameter tool at 8% coverage this is a substantial gap.

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

Purpose3/5

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

The description identifies the resource ("a library document") and the retrieval mode ("exact, bounded text"), but never states a clean verb-subject pair and offers no differentiation from the sibling read_document or list_project_documents. An agent can guess it reads document content, but cannot tell from this text alone why it should pick this tool over read_document.

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

Usage Guidelines3/5

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

"Follow text and comment continuations" gives implied usage guidance for paginated reads, and the archive-receipt sentence implies when review data should be trusted. Beyond that there is no explicit when-to-use, no when-not-to-use, and no named alternative despite a closely related sibling.

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