get_doc
Read one Druxt documentation page as markdown, by its path, such as /how-to/proxy.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | The page path. |
Read one Druxt documentation page as markdown, by its path, such as /how-to/proxy.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | The page path. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the safety profile is covered; the description adds the return format (markdown), which is real context beyond the annotations. No error behavior for a missing/invalid path is disclosed.
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?
One short sentence, front-loaded with the verb and resource, then the path requirement and format example. Nothing wasted.
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 simple single-parameter read tool with annotations and no output schema, the definition is essentially complete: what it returns (markdown) and how to address a page are both stated. Only error/miss handling is unaddressed, a minor gap.
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% and the single parameter is documented there, but the description adds an illustrative path shape (/how-to/proxy) that clarifies format beyond 'The page path.' Minor added value is appropriate for a one-param 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?
States a specific verb (Read) and a precisely scoped resource (one documentation page, returned as markdown). The singular 'one page' implicitly contrasts with the list_docs and search_docs siblings, though it never names them explicitly.
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: the tool requires an exact path, which suggests the agent must already know it, but the description never says to use search_docs or list_docs when the path is unknown. No when-not guidance is given.
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.