docs_read_page
Read a documentation page as markdown. Accepts a full URL from search_docs, or a path such as /reference/ or /guides/send-invoice.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Page URL or path. |
Read a documentation page as markdown. Accepts a full URL from search_docs, or a path such as /reference/ or /guides/send-invoice.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Page URL or path. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuinely new behavioral information by disclosing that the page is returned as markdown, which is not captured anywhere else in structured data. It stops short of noting size limits, truncation, or auth requirements.
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?
Two sentences, zero padding, with the core action front-loaded and the input formats immediately after. Every clause carries usable information.
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?
For a single-parameter read tool whose annotations fully cover the safety profile and which has no output schema, the description is close to sufficient: it says what it reads and what it returns. Minor gaps remain around the sibling-name mismatch ('search_docs' vs docs_search) and invalid-input behavior.
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 coverage is 100%, so the baseline is 3, but the description goes beyond the schema's terse 'Page URL or path' by enumerating the accepted forms (full URL or path) and giving concrete examples such as /reference/ and /guides/send-invoice, which clarifies that directory-style paths are valid.
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+resource ('Read a documentation page') and the exact return format (markdown), which separates it from docs_search. It references the sibling that supplies URLs ('search_docs'), but the name doesn't match the actual sibling (docs_search), and it never explicitly contrasts itself with docs_list_endpoints or docs_get_auth_guide.
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?
Usage is only implied through the workflow hint that the URL comes from search_docs. There is no explicit when-to-use/when-not statement and no guidance on choosing this over docs_list_endpoints or docs_get_auth_guide, nor any note on error behavior for bad paths.
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.