Skip to main content
Glama

read_chunks

Returns full text of selected documentation chunks with source citations, so agents can retrieve exact sections found by search or outline without fetching entire pages. Supports a token budget.

Instructions

Return the full text of selected chunks (from search_docs / get_page_outline) with citations.

Args:
    ids: chunk ids exactly as shown in [brackets] by search_docs / get_page_outline (never invent ids).
    max_tokens: approximate budget; chunks beyond it are listed but not returned.

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": {
      "ids": "<ids>"
    },
    "name": "read_chunks"
  }
}

Input Schema

NameRequiredDescriptionDefault
idsYes
max_tokensNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

No annotations exist, so the description carries the full behavioral burden. It does disclose one genuinely non-obvious trait — chunks beyond max_tokens are listed but not returned — but says nothing about ordering, error behavior on invalid ids, or whether citations are formatted inline or as metadata.

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?

Front-loaded with the core purpose in the first sentence, followed by a compact per-argument breakdown; there is no filler. The raw "Args:" docstring formatting is slightly less polished than a prose description but costs nothing in clarity.

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

Completeness4/5

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

For a two-parameter read tool with an output schema that already defines return values, this covers everything an agent needs to call it correctly: where ids come from, the no-invention rule, and truncation behavior. Multimodal or edge-case handling is out of scope and reasonably omitted.

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 0%, so the description must compensate and largely does: `ids` is tied to the bracketed values emitted by the search tools with an explicit "never invent ids" warning, and `max_tokens` is described as an approximate budget with defined truncation semantics. It does not state how ids are ordered or whether duplicates are deduplicated.

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

Purpose5/5

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

States a specific verb and resource ("Return the full text of selected chunks") plus a distinguishing extra ("with citations") and names the tools that produce the inputs. An agent can immediately tell this is a fetch-by-id tool, not a search tool, without opening the sibling schemas.

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?

The dependency on search_docs / get_page_outline makes the intended workflow clear: run a search first, then read the resulting chunk ids. There is no explicit when-not-to-use statement or note about what to do if the budget truncates results, so it stops short of the top score.

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