add_comment

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

Beyond the annotations (openWorld, non-idempotent, non-destructive write), the description discloses two non-obvious traits: a user-confirmation gate in the MCP client and a prompt-injection warning about collaborator-authored content in results and written files. That is genuine value the structured fields cannot convey. It stops short of describing failure modes or what the comment reference looks like.

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?

Three sentences with the action stated first, followed by the confirmation behavior and the trust-boundary warning. The security sentence is lengthy but justified for an open-world write tool; nothing is redundant.

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?

For a write tool with complete annotations and full schema coverage, the remaining burden is behavioral context, which the confirmation note and injection warning supply. No output schema exists, but the description does not explain what a successful add returns, leaving a small gap.

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 100%, so every parameter including the position vs line/column alternative is already documented in the schema. The description adds no anchoring or formatting guidance beyond what the schema provides, which is the baseline 3 case.

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?

States a specific verb and resource ('Add a review comment') plus the anchoring scope ('to a specific location in an Overleaf project document'), which implicitly distinguishes it from reply_to_comment and resolve_comment. It never names those siblings explicitly, so an agent must infer the boundary rather than being routed.

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 implies when it applies (creating a new anchored comment) and notes a confirmation prompt, but gives no explicit when-not guidance or naming of alternatives such as reply_to_comment for threading on an existing comment. Usage is inferable but not spelled out.

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