Add Document Note

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

Annotations already declare readOnlyHint=false and idempotentHint=false, so the mutation profile is covered. The description adds no further behavioral detail – no mention of what is changed, whether existing notes are preserved, auth requirements, or error conditions – it essentially paraphrases the tool name.

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 concise sentence with no redundancy or filler. It front-loads the only necessary action and is appropriately sized for the tool's simplicity.

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?

The tool is simple (2 scalar params, output schema exists) and the description captures the core operation, so it is minimally complete. However, it does not explain how the note relates to the document's existing notes or when this should be used over update_document/get_document_notes, leaving some gaps.

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 0%, so the description must compensate. It only confirms document_id identifies the document and note is the text to append, which is marginally more than the parameter names. No constraints, formatting, or examples are provided, leaving the agent to infer note length or content rules.

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 uses a specific verb ('Append') and resource ('note to a document'), making the action immediately clear. However, it does not explicitly differentiate itself from sibling tools like get_document_notes or delete_document_note, though the verb choice helps.

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 gives no guidance on when to use this tool instead of alternatives such as update_document, get_document_notes, or delete_document_note. No prerequisites, exclusions, or alternative conditions are mentioned.

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