Skip to main content
Glama

read_document

Read-onlyIdempotent

Read the published Markdown of one document, usually selected from the read_project index by its update triggers. Optional section is an exact heading; offset and limit_chars paginate at line boundaries. Returns content, revision (the base_revision for changes), section hashes to quote when writing, total_chars, truncated and next_offset.

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>",
      "document_id": "<document_id>"
    },
    "name": "read_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
offsetNo
sectionNo
project_idYes
document_idYes
limit_charsNo
result_offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent and non-destructive, so the safety profile is covered. The description adds real value beyond that: it discloses the return fields (content, revision as the base_revision for changes, section hashes to quote when writing, total_chars, truncated, next_offset) and the line-boundary pagination rule. It does not mention error behavior for a missing or ambiguous heading.

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?

It is two dense sentences with no waste, front-loading the purpose before parameter behavior and return values. The return-value sentence becomes a long run-on list, but every element in it is informative.

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

Completeness3/5

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

There is no output schema, and the description usefully enumerates the response fields, which covers the return side well. Against 0% schema coverage and six parameters, however, the unexplained result_offset and undescribed required IDs leave meaningful gaps for an agent trying to invoke it correctly.

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

Parameters3/5

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

Schema description coverage is 0%, so the description carries the full burden, and it only partially compensates. It clarifies that 'section' is an exact heading and that offset/limit_chars paginate at line boundaries, but project_id and document_id are left implicit and result_offset is never explained or distinguished from offset, which is a genuine ambiguity in a 6-parameter tool.

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 description opens with a specific verb and resource: 'Read the published Markdown of one document.' It scopes the tool to a single document and names the upstream index (read_project) it is normally reached from, which separates it from search_documents and read_outline. It stops short of explicitly naming the sibling it replaces in ambiguous cases, so it lands at 4 rather than 5.

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?

It supplies an implied workflow ('usually selected from the read_project index by its update triggers') and indicates when to use the section/offset/limit_chars options. There is no explicit when-not guidance and no named alternative for cases like full-text lookup or outline browsing. Usage is inferable but not spelled out.

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