Swagger: Get Document

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the agent knows it is a safe read. The description adds value by specifying that it retrieves HTML or Markdown content, but does not disclose additional behavioral details beyond those already captured by annotations.

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 extremely concise, using two sentences plus structured parameter info. It is front-loaded with the core purpose and contains no superfluous information.

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 tool is simple (one required parameter, read-only, with an output schema), the description is adequate. It mentions the type of content returned, and the output schema covers return values. Missing details like pagination or error handling are not necessary for this tool.

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 description repeats the schema description for the parameter without adding new meaning. The agent can fully understand the parameter from the schema alone.

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 action ('Get document content and metadata') and the resource ('by document ID'). It also specifies the type of content (HTML or Markdown from table of contents items), distinguishing it from sibling tools like swagger_get_api_definition or swagger_update_document.

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 clear context on when to use the tool ('Useful for retrieving HTML or Markdown content from table of contents items'), but does not explicitly mention when not to use or provide alternatives. It is adequate for a simple read operation.

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