add_comment

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

Discloses internal mechanism (creates in comments.xml, adds range markers) beyond basic function. With no annotations, this provides useful behavioral context, though permissions or side effects are not mentioned.

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?

Front-loaded with purpose, then behavior, then parameters. Efficient use of sentences, but the 'Args' section could be integrated for slightly better flow.

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?

Given the output schema exists (though not shown), the description adequately covers input semantics and behavior. Leaves out return value details, but that is handled by the output schema.

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?

All three parameters have meaningful descriptions in the Args section: para_id (paragraph to comment on), text (comment text), author (shown in sidebar). The schema has 0% coverage, so the description fully compensates.

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?

Clear verb 'add' and resource 'comment anchored to a paragraph' provide specific purpose. Distinguishes from sibling tools like get_comments and reply_to_comment by focusing on adding a new comment at a specific paragraph.

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 implies use when anchoring a comment to a paragraph but lacks explicit guidance on when to use this tool vs alternatives like reply_to_comment. No exclusions or prerequisites mentioned.

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