catia_add_lesson

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

Annotations already declare write (readOnlyHint=false), non-idempotent, non-destructive. The description adds real context beyond that: storage location ('user's lessons file, not in the package') and dedup behavior ('duplicates are refused'), which are not derivable from annotations or schema.

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?

Four dense sentences, all load-bearing, with the primary action front-loaded. Slightly long but no filler or repetition.

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?

Covers purpose, trigger, storage, and dedup for a 9-param write tool with no output schema. Minor gaps remain (what a duplicate returns, whether the lesson is immediately live), but nothing critical is missing.

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 coverage is 78% (baseline 3), but the description adds meaning the schema lacks: error_patterns must be the 'exact observed error text (regex)' and proof must state 'how it was proven', clarifying the intent of two non-obvious fields.

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?

States a specific verb ('Record') and resource ('a NEW pitfall or rule'), plus the effect ('every future session ... is warned automatically'). The write intent clearly contrasts with the read-only sibling catia_lessons, even without naming it.

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?

Gives explicit timing/trigger: 'Use it as soon as you find something that failed, surprised you, or needed a workaround.' No when-not guidance or named alternative, but the invocation context is unambiguous.

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