flowzap_apply_change

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively communicates that the tool performs mutations ('apply a change') and is safer than full regeneration, but lacks details on error handling, atomicity of operations, permission requirements, or what the return value contains. It adds some context but leaves significant behavioral aspects unspecified.

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 a single, well-structured sentence that efficiently conveys the tool's purpose and key advantage. Every word earns its place, with no redundancy or unnecessary elaboration, making it easy to parse and understand quickly.

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 mutation tool with no annotations and no output schema, the description provides adequate purpose and usage context but lacks details on behavioral outcomes, error conditions, or return values. It compensates somewhat by highlighting safety and preservation, but doesn't fully address the complexity implied by the detailed input schema for patch operations.

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 description coverage is 100%, so the schema already documents both parameters ('code' and 'operations') and their nested structures comprehensively. The description doesn't add any parameter-specific semantics beyond what's in the schema, such as explaining operation sequencing or validation rules, meeting the baseline for high 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?

The description clearly states the specific action ('apply a structured change') and resource ('FlowZap Code'), specifying it involves insert/remove/update operations on nodes or edges. It distinguishes from potential siblings by contrasting with 'regenerating entire diagrams' and emphasizing preservation of existing structure.

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 provides clear context for when to use this tool ('safer than regenerating entire diagrams - preserves existing structure'), which implicitly suggests it's preferable for incremental modifications. However, it doesn't explicitly name alternatives or specify when not to use it, such as when starting from scratch or needing complete overhauls.

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