get_env_variable

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 does not disclose behavior such as what happens if the variable is undefined, whether the name should include the '$' prefix, or whether any side effects or read-only guarantees exist. The description is purely functional with no added behavioral context.

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?

A single sentence with an effective example list. No wasted words, and the information is front-loaded. The parenthetical examples add concrete value without bloat.

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 getter, the description is adequate but minimal. It is missing details about return value format, error handling for unknown variables, and whether it only works for Houdini-specific variables vs OS environment variables. Given the absence of an output schema or annotations, a bit more behavioral detail would improve completeness.

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 schema provides only a 'name' property with no description. The tool description adds context by naming example variables ($HIP, $JOB), which suggests what to pass. However, it does not explicitly state whether the '$' prefix is required or optional, leaving ambiguity. It partially compensates for the 0% schema coverage but could be clearer.

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 verb 'Get' and the resource 'Houdini environment variable', with concrete examples ($HIP, $JOB) that distinguishes it from sibling tools like get_parameter or get_expression. The purpose is immediately unambiguous.

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 gives clear context for when to use this tool: to retrieve Houdini environment variables. It does not explicitly mention alternatives or exclusions, but the specificity of the resource makes the usage context apparent, especially when compared to the broader list of sibling tools.

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