add_comment

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

Discloses format-specific behavior (ODT uses office:annotation, threaded replies DOCX-only) beyond annotations. Does not mention side effects or revertibility, but annotations already indicate write operation.

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?

Two sentences, front-loaded with action, no wasted words. Every sentence provides necessary information.

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 main use cases and limitations. Lacks return value or error details, but given no output schema, it's reasonably complete for decision-making.

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 100%, but description adds context: parameter relationships (root vs reply), default behavior (anchor_text omission anchors to entire paragraph), and initials default. Adds meaningful value over 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?

Description clearly states it adds a comment or threaded reply to a document, specifying verb and resource. It distinguishes from siblings like delete_comment or get_comments by focusing on addition.

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?

Explicit guidance on when to use each parameter combination (root vs reply) and format support (DOCX/ODT). Lacks direct exclusions or alternatives but provides clear context for selection.

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