Get Comments

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

Annotations declare readOnlyHint=true, and the description ('Get comments') is consistent with a read-only operation. However, the description adds no further behavioral context such as pagination, ordering, or whether inline comments are included. It relies on the annotation for safety, meeting the baseline without enhancement.

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 a single, front-loaded sentence with no filler words. It efficiently conveys the tool's purpose without redundancy.

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 the tool's simplicity (one parameter, read-only, output schema present), the description is mostly complete. However, it does not clarify the distinction between regular comments and inline comments (handled by a sibling tool), which could cause confusion for the agent. This minor gap prevents a perfect score.

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?

The input schema provides 100% coverage with a detailed description for page_id, including URL parsing guidance. The tool description's mention of 'a specific Confluence page' adds no additional meaning beyond the schema, so the baseline of 3 applies.

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 the tool retrieves comments for a specific Confluence page, using a specific verb ('Get') and resource ('comments') with a target. This distinguishes it from siblings like confluence_get_inline_comments and confluence_get_page.

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 the tool is used for fetching page comments, but it does not explicitly state when to use it over alternative tools such as confluence_get_inline_comments. There is no mention of exclusions or when-not-to-use scenarios, so the guidance is only implied.

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