update_glossary_entry

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

Describes partial update, case-insensitive term_or_id identification, and special values for clearing optional fields (e.g., empty string or null for domain). Does not cover error cases or idempotency, but given no annotations, this is adequate.

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?

Well-structured as a docstring with a one-line summary, Args section, and Returns section. Every sentence adds essential information without redundancy.

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?

Given the tool's complexity (6 parameters, no output schema, no annotations), the description fully covers what the tool does, its parameters, and return value. No gaps remain.

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?

With 0% schema description coverage, the description explains all six parameters in detail, including types, optionality, and special behaviors (e.g., 'pass [] to clear' for aliases). Adds significant value over the raw schema.

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 'Update an existing glossary entry,' specifying the verb and resource. Distinguishes from sibling 'add_glossary_entry' by implying modification rather than creation.

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?

Indicates partial update behavior ('Only provided fields are updated'), but does not explicitly list when to use this tool versus alternatives like 'delete_glossary_entry' or 'add_glossary_entry'. Context is clear but lacks exclusion guidance.

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