get_topic

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

No annotations are provided, so the description carries full burden. It correctly conveys a read-only retrieval operation returning Markdown content, but adds no extra behavior details such as error cases, idempotency, or rate limits. Minimal but not misleading.

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 concise sentences that front-load the core purpose and immediately follow with the prerequisite workflow. No superfluous words or redundancy.

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 retrieval tool with no output schema, the description sufficiently covers the core workflow and output type. It lacks edge-case details like what happens if the ID is invalid, but given the minimal complexity, it is largely 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 coverage is 100% for the single parameter topic_id, and the description reinforces its meaning by stating that the ID comes from search_docs. This adds useful provenance beyond the schema's 'Topic ID returned by search_docs' and helps the agent understand how to obtain the correct value.

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 uses a specific verb ('Retrieve') and resource ('full Markdown content of a specific documentation topic by its ID'), clearly distinguishing it from sibling tools like search_docs which locate topics. It leaves no ambiguity about what the tool does.

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?

Explicitly instructs to 'Use search_docs first to find the topic_id, then call this to read the full content.' This provides a clear workflow and states when to use this tool relative to an alternative, satisfying the when/how guidance.

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