Search TD Python API

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

The readOnlyHint annotation already covers safety, and the description adds useful behavioral details: the knowledge base is embedded offline and version filtering is conservative, only applying where compatibility metadata exists. It doesn't contradict annotations and adds meaningful context beyond them.

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-loaded with 'Read-only' and a clear action. No redundant content; every clause adds 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 output schema and full parameter descriptions, this is sufficiently complete: it states the search source, scope, and filtering capabilities. The only missing context is explicit comparison to sibling tools, but that's covered under usage guidelines.

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 provides 100% parameter coverage, so the baseline is 3, but the description adds nuance: version filtering is 'conservative' and only applied 'where compatibility metadata exists', clarifying the version parameter's behavior. It also explicitly mentions class category filtering, reinforcing the category parameter's purpose.

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 searches TouchDesigner Python API classes, methods, and members from an embedded offline knowledge base, using specific verbs and a defined resource scope. It distinguishes itself from sibling search tools like search_operators and search_touchdesigner_knowledge by targeting the Python API specifically.

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 context: querying the offline Python API knowledge base, with optional filters for category and version. It does not explicitly name alternative tools or state when not to use it, but the context is clear enough for an agent to differentiate.

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