confluence_get_comments

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

No annotations provided, so the description must carry the burden. It mentions the return format as 'JSON string representing a list of comment objects' but fails to disclose behaviors like error handling, rate limits, or authentication needs. For a simple read operation, minimal transparency is provided.

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?

The description is concise and well-structured, with a clear sentence for purpose and a parameter block. No unnecessary information; every sentence serves a purpose.

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 an output schema exists, the description's mention of return format is sufficient. The param is well-covered. However, it lacks usage context and error scenarios, but for a straightforward GET operation, it is reasonably complete.

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% with a clear description of page_id, including a helpful note on parsing it from a URL. The description adds practical context beyond the schema, aiding the agent in correct parameter usage.

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?

The description clearly states 'Get comments for a specific Confluence page,' specifying the verb and resource. It distinguishes from sibling tools like 'confluence_get_page' and 'confluence_get_labels' by targeting comments, though it doesn't explicitly contrast with 'confluence_add_comment'.

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?

No guidance on when to use this tool versus alternatives, such as other comment retrieval methods. No prerequisites or exclusions mentioned. The description merely states the function without usage context.

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