verify_hou_api

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

Given no annotations, the description carries the burden of disclosing behavior. It does describe the return dict fields, the presence of _ai_hint, a fallback for unreachable SideFX, and timeout defaults. However, it does not mention potential side effects, error behavior, or what 'apply_response_cap' means.

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 well-structured with bullet points for parameters, examples, and return format. It is appropriately sized, with no unnecessary fluff, and front-loads the purpose.

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?

No output schema exists, but the description explains return fields and the AI hint, which partially compensates. However, it lacks usage context compared to get_houdini_help, omits the ctx parameter, and does not cover error scenarios, making it moderately complete for a wrapper 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 has no descriptions, but the description covers item_name, help_type, and timeout with useful details including examples and default values. The critical omission is that required parameter ctx is not mentioned at all, leaving a significant gap for agent understanding.

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 it is an 'AI-friendly wrapper over get_houdini_help' and clearly indicates it queries hou API/node/VEX function names. It provides a specific verb+resource, but since it's a wrapper, it doesn't explicitly distinguish itself from get_houdini_help.

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 does not provide explicit guidance on when to use this tool versus alternatives like get_houdini_help. It only mentions being a wrapper, implying some use cases but without clear context, exclusions, or alternative recommendations.

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