Read doc
read_docOne docs page as Markdown, by its slug.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | The page, like `quickstart` or `api/create-formation`. Leave it out for the overview. |
read_docOne docs page as Markdown, by its slug.
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | The page, like `quickstart` or `api/create-formation`. Leave it out for the overview. |
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, closed-world, so safety is covered. The description adds genuinely new information by stating the return format is Markdown, but says nothing about missing-slug behavior or page size.
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?
A single front-loaded sentence with zero filler; every clause (resource, format, key) carries meaning.
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 one-parameter read tool with full annotation coverage and a well-documented schema, the description covers what the tool returns and how it is keyed. Only edge-case behavior (unknown slug) is unaddressed, which is minor.
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 100% and already explains the slug format and the omit-for-overview behavior. The description's 'by its slug' adds no syntax or format detail beyond the schema, so baseline 3 applies.
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 ('one docs page') plus the output format ('Markdown') and the lookup key ('by its slug'). It implicitly contrasts with the sibling search_docs (one page vs. search) but never names it, so differentiation is left to inference.
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?
The phrase 'by its slug' implies you need a slug, and the schema notes the slug can be omitted for the overview. However, there is no explicit when-to-use vs. search_docs, and no guidance on what to do when the slug is unknown.
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.