Get Python API Documentation

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

No annotations are provided, so the description carries the full burden. It states the tool gets documentation and can filter by version, but does not mention whether it is read-only, has rate limits, or what exactly is returned (text, structure, etc.). The behavior is partially clear but missing important details.

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 sentences front-load the purpose and key optional filter. No superfluous words or repetition. Efficient and focused.

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 tool with 5 parameters (1 required) and no output schema, the description covers the main purpose and version filter but omits details on boolean flag interactions and the format of returned documentation. More context would help an agent use it effectively.

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 100% coverage with descriptions for all 5 parameters. The description adds minimal value beyond the schema: it mentions optional version filtering but doesn't explain the interplay between show_members, show_methods, and show_inherited. With full schema coverage, a baseline of 3 is appropriate.

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 tool retrieves documentation for a TouchDesigner Python class with optional version filtering. It specifies the resource ('TouchDesigner Python class') and action ('Get documentation'), distinguishing it from sibling tools like search_python_api and list_python_classes.

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 when needing documentation for a specific class, but does not explicitly state when to use this tool over others, nor does it provide conditions or prerequisites. Usage is inferred but not guided.

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