Get Issue Comment

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

Annotations already indicate readOnlyHint, idempotentHint, and non-destructive nature. The description adds behavioral context by documenting that if the issue tracker is disabled, it returns an error object, and notes that workspace defaults to configured workspace.

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 extremely concise: two short paragraphs using an Args/Returns structure. Every line provides necessary information without redundancy or filler.

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 simple parameter set (4 string parameters, 3 required) and the presence of an output schema, the description covers the essential behavior. It mentions a key edge case (issue tracker disabled) and default workspace behavior. Could be slightly more thorough about return format, but adequate.

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?

With 0% schema description coverage, the description adds value by naming each parameter with a brief explanation (e.g., 'Repository slug', 'Issue ID'). It also clarifies that workspace is optional and defaults to the configured workspace, which is not in the 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?

The description clearly states 'Get a specific comment on an issue,' using a specific verb and resource. It distinguishes itself from siblings like 'get_issue_comments' (plural) and 'get_pull_request_comment' (different context).

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 does not explicitly state when to use this tool over alternatives, nor does it provide exclusion or prerequisite information. Usage is implied by the name and parameter structure, but no direct guidance is given.

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