Get Issue Comments

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It simply states 'Lists all comments' and the endpoint, without explaining pagination behavior, whether the result is a complete list or as-yet-unloaded pages, or any authentication/permission requirements. The GET endpoint implies read-only, but key behavioral traits are missing.

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 sentence that immediately states the action and resource, with the REST endpoint in parentheses for precision. There is no redundant text or padding; every element earns its place, making it highly concise and well-structured.

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, no annotations, no output schema), the description provides a minimal but workable overview. It fails to mention the structure of the returned comments (e.g., comment bodies, authors, timestamps) or any pagination limits, which are gaps an agent might need. This is adequate for a basic tool but not fully 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%, and the sole parameter issueKey is already clearly described in the schema with an example ('ABC-123'). The description's endpoint reference including {key} adds no additional semantic meaning beyond what the schema provides, so the baseline score of 3 is appropriate.

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 'Lists all comments on an issue' uses a specific verb ('Lists') and resource ('comments on an issue'), making the tool's purpose immediately clear. The REST endpoint reference further reinforces the named resource and distinguishes it from siblings like add_comment (which creates) and get_issue (which retrieves issue details).

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 for retrieving comments when needed, but provides no explicit when-to-use guidance, exclusions, or comparisons to alternatives. The presence of sibling tools like add_comment and get_issue is not leveraged to clarify use cases, so it remains at the 'implied usage' level.

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