get_topic

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

With no annotations, the description must disclose behavioral traits. It clearly states the tool returns Markdown content, which conveys the output format. However, it lacks details about error handling (e.g., invalid topic_id), potential size limits, or any permission requirements, leaving some behavioral ambiguity for a read operation.

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 two sentences, with the primary action stated in the first sentence and supplementary usage guidance in the second. Every word contributes value, with no redundancy or unnecessary detail.

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 one-parameter read tool, the description covers the essential steps: how to obtain the parameter and what the tool returns. It lacks some edge-case details like handling of missing IDs or content formatting nuances, but given the low complexity and clear sibling context, it is nearly complete.

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% as the only parameter topic_id is described as 'Topic ID returned by search_docs.' The description adds the context of searching first but does not provide additional parameter details beyond what the schema already states, so it meets the baseline without exceeding it.

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 states a specific action ('Retrieve the full Markdown content') on a specific resource ('a specific documentation topic by its ID'), making the purpose immediately clear. It also distinguishes itself from sibling tools by explicitly referencing search_docs for finding the topic_id, which prevents confusion.

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 provides explicit workflow guidance: 'Use search_docs first to find the topic_id, then call this to read the full content.' This tells the agent exactly when to use this tool and how it fits in sequence with search_docs, effectively differentiating it from alternative approaches.

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