read_document

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

Adds significant behavioral context beyond the readOnlyHint annotation: describes output structure (interleaved headings, descriptions) and warns about destructive sink behavior (anchors collapse, headings orphan).

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 concise, front-loaded sentences. Each sentence serves a distinct purpose: function, output structure, usage warnings and alternatives. No redundancy.

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?

Covers purpose, output, and critical behavioral constraints. Mild gap: does not clarify interaction with pagination parameters despite stating 'end-to-end' rendering.

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 covers 3 of 5 parameters with descriptions. The description does not elaborate on the two undocumented pagination parameters (page_size, page_number) or clarify whether they are respected by the tool.

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?

Clearly states the verb ('Render'), resource ('a document'), and output format ('flowing Markdown'). Distinguishes itself as the primary method to read a document body.

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?

Explicitly provides when to use ('THE way to read a body'), when not to ('NEVER feed to update_document'), and alternative tools for different use cases (get_document for round-trip, list_work_items for metadata).

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