Create Comment

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

Description says 'This writes collaboration state,' confirming it's a mutation, which aligns with annotations (readOnlyHint=false). No contradictions. Could add auth or response details, but with annotations present, this is sufficient.

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 only. First sentence states purpose, second gives usage alternative. No wasted words.

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?

No output schema, but description covers key aspects: creation, usage alternative, parameter nuance. Could mention success response, but not essential for selection.

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%, so baseline is 3. Description adds nuance for 'content' parameter: explains normalization of plain strings and pass-through of rich payloads. This provides value beyond 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?

Clearly states it creates a new comment on an existing document. Distinguishes from sibling 'update_comment' by saying 'use update_comment when editing an existing comment instead.'

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?

Explicitly says when to use this tool (create new comment) and when not to (use update_comment for editing). Also mentions it writes collaboration state, indicating it's a write operation.

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