read_documentation
Read a source snapshot by handle with offset and limit. Follow next_offset; expired handles require fresh retrieval. Public access.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| handle_id | Yes |
Read a source snapshot by handle with offset and limit. Follow next_offset; expired handles require fresh retrieval. Public access.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| handle_id | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare read-only, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuinely useful context beyond that: pagination via next_offset, handle expiry semantics, and no-auth 'public access'.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three short sentences, front-loaded with the core action and no filler. The pagination and expiry notes are each worth their space, though the phrasing is telegraphic to the point of under-explaining.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description helpfully names next_offset as a return field and covers expiry, but it never explains what a 'source snapshot' or handle is, how one is obtained, or what the returned content looks like. Adequate for a read tool, but gaps remain.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
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, yet it only names the three parameters ('by handle with offset and limit') without explaining handle format, limit default of 12000, or the 16000 maximum. It adds naming but no usable semantics.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Read a source snapshot by handle'), and the mention of offset/limit makes the scope concrete. It does not distinguish itself from the sibling 'inspect_documentation', so an agent must guess which doc-reading tool applies.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives real operational guidance — follow next_offset for pagination, and expired handles need fresh retrieval — which implies the refresh workflow. However, it never names the relevant alternative (request_documentation_refresh, inspect_documentation), so the routing decision is left to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.