Comment on Document (Outline)

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. Description adds that write access is required and explains parentCommentId behavior for threading. However, it does not disclose other behavioral details such as error handling or limits beyond annotations.

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?

A single concise sentence of 15 words front-loads the action and adds key detail about parentCommentId. No redundant 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?

Description covers purpose, permission, and one parameter, but lacks guidance on return values (no output schema) and error conditions. For a simple creation tool, it is minimally adequate but could be more helpful.

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 must compensate. It only explains parentCommentId as 'replies to a thread', providing no additional meaning for 'text' or 'documentId'. This leaves major gaps for the two required 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?

Description states 'Add a comment to a document' with specific verb and resource. It also notes that parentCommentId is for replying to a thread, distinguishing from sibling tools like outline_list_comments or outline_create_document.

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?

Description includes 'Requires write access' as a prerequisite, but does not explicitly state when to use this tool versus alternatives like outline_list_comments or outline_update_document. Usage context is implied but not fully clarified.

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