Add Document Note

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

Annotations already provide key behavioral hints (readOnlyHint=false, idempotentHint=true, destructiveHint=false). The description does not contradict these and adds a note on the intended use of notes, but it does not disclose whether notes are appended, replaced, or how repeated calls behave beyond the annotations. With annotations covering safety, the description adds minimal extra transparency.

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 concise, with exactly two sentences. It front-loads the action and adds a purposeful explanatory sentence without any redundant fluff. Every sentence contributes value.

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 (two string params) and has an output schema, so the description need not explain return values. However, it leaves ambiguity around whether notes overwrite existing notes or are appended, and it does not specify the doc_id format. These gaps prevent it from being fully complete.

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 gives some hint about the 'notes' parameter ('contextual note... when/how to use this document') but does not clarify 'doc_id' or the expected format/structure of notes. This is insufficient for fully understanding the parameters.

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 clearly states the action: 'Attach a contextual note to a document.' This specifies the verb (attach), resource (document), and distinguishes it from sibling tools like vault_add_doc or vault_tag_doc. The second sentence provides additional context about the note's purpose, reinforcing clarity.

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 explains the purpose of notes ('help you and your AI assistant understand when/how to use this document') but does not explicitly state when to use this tool versus alternatives or any exclusions. Usage is implied rather than stated, so it falls short of clear guidance.

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