update_endnote

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

No annotations provided, so description carries full burden. Only states 'Update', implying mutation, but doesn't disclose error behavior (e.g., if endnote_id missing), side effects, or return value. Lacks sufficient behavioral context.

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?

Extremely concise: one sentence for purpose followed by a bulleted list of parameters. No redundant information. Every sentence 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?

Simple tool with 2 parameters and no nested objects. Description covers purpose and parameter constraints. Missing output explanation, but output schema exists. Minor gap about error handling, but overall sufficient.

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 0%, so description is the sole documentation. It adds constraints: endnote_id must be >= 1, and text is 'new text content'. This provides meaning beyond the raw integer/string types in the 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 the text of an existing endnote', specifying the verb 'update', resource 'endnote', and the specific attribute 'text'. It distinguishes from sibling tools like add_endnote (create) and delete_endnote (remove).

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?

Implied usage: you use this tool to modify the text of an existing endnote. However, no explicit guidance on when to use it versus alternatives like update_footnote or when not to use it.

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