connect_niagara_pins

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

Mentions validation and clean type mismatch rejection, adding behavioral context. No annotations exist, but description doesn't cover side effects, permissions, or limitations beyond validation.

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?

Three sentences, front-loaded with key action. Each sentence adds value, though could be slightly more streamlined.

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?

Adequate for a tool with many siblings, but lacks explanation of system_path and module_name, and does not describe output. Under-specified for full context.

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?

Explains how to identify pins via (class|index|id) trio, which maps to parameters. Adds significant meaning for those fields, but leaves system_path and module_name unexplained, with 0% schema coverage.

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?

Clearly states the action (wire pins), context (scratch pad graph), and identification method (class|index|id trio). Distinguishes from sibling tools like connect_material_expressions by specifying Niagara.

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?

Provides identification guidance but no explicit when-to-use vs alternatives or prerequisites. Implies usage through context but lacks exclusion criteria.

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