add_comment

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

Discloses authentication (authored as connected user), anchoring behavior (optional lineNumber), and email side effect for external replies. With no annotations, it covers key behavioral traits.

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 concise sentences, front-loaded with primary action, every sentence adds value. 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?

Lacks return value details (e.g., comment ID or success indicator). No output schema, so description should fill that gap. Otherwise complete for a create tool.

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 covers 100% of parameters, but description adds context: content is plain text, parentCommentId sourced from list_comments, lineNumber is 1-based. Adds meaning 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?

Description clearly states it adds a comment or replies, with specific verb and resource. It distinguishes from siblings like 'list_comments' (list) and 'resolve_comment' (resolve).

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 describes when to use (add comment or reply) and a side effect (email to external commenters). Implicitly contrasts with siblings, but no explicit when-not-to-use.

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