investigation_delete_note

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

Discloses destructive action (hard-delete) and confirmation requirements. With no annotations, it covers key behavioral traits, though could detail side effects or reversibility.

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, zero waste. Front-loads purpose, then adds critical constraints. Every part earns its place.

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?

Sufficient for a delete operation; output schema exists so return values are covered. Could note how to obtain note_id, but siblings like investigation_list provide that 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?

Description adds meaning beyond schema by specifying that confirm=True is required and that confirm_production is needed in production. Note_id is not elaborated, but the confirmation parameters are effectively explained.

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 'hard-delete an investigation note by note_id', specifying action and target. Distinguishes from sibling tools like investigation_add and investigation_delete_experiment.

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?

Explicitly states the requirement for confirm=True and confirm_production=True in production. Provides clear conditions for use but lacks alternatives or when-not-to-use guidance.

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