get_doc

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

The description is straightforward about returning page data with no hidden behaviors. No annotations are provided, but the tool is read-only in nature. It does not disclose error handling or edge cases, but the description is sufficient for a simple retrieval tool.

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?

The description is a single, front-loaded sentence that wastes no words. It efficiently communicates the tool's purpose and output.

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?

Given the low complexity (one parameter, output schema present), the description covers the return value adequately. However, the complete lack of parameter explanation leaves the definition incomplete for correct invocation.

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?

The input schema has 0% description coverage for the 'page_id' parameter. The tool description does not explain the parameter's format, expected value, or any constraints. This is a significant gap that makes it hard for an agent to know how to correctly provide the parameter.

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?

The description clearly states the verb ('Return') and resource ('one captured page'), and lists what is included (metadata, source URL, full markdown). It is easily distinguished from sibling tools like 'search_docs' (which searches) and 'list_docs' (which lists multiple pages).

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 description implies usage for fetching a single page by ID, which is distinct from listing all pages or searching. However, it does not explicitly state when to use this tool versus alternatives or provide any exclusion criteria.

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