confluence_add_comment

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

With no annotations, description must disclose behavior. States it adds a comment (write operation), but lacks details on authentication, rate limits, error handling, body formatting (HTML/markdown), or visibility of new comments. Incomplete for a mutation tool.

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, concise and front-loaded with primary purpose. Minor lack of structure could be improved with formatting hints, but overall efficient.

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?

Simple tool with 3 params and output schema exists, so return value not needed. But missing details like body format, page_id type, and prerequisites. Adequate but not thorough.

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 0%, so description adds meaning where it can. Explicitly explains parent_comment_id usage. Implies page_id and body are required but adds no format or constraints beyond schema. Partially compensates but not fully.

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 'Adds a comment to a Confluence page' with specific verb and resource. Distinguishes from siblings like 'confluence_get_comments' and 'jira_add_comment' by naming Confluence specifically and mentioning reply functionality.

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?

Gives guidance on when to set parent_comment_id (to reply), but does not explicitly contrast with alternatives like 'confluence_get_comments' or mention when not to use this tool. Context for usage is implied but not fully explicit.

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