seerr_get_issuecomment

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

The readOnlyHint annotation already establishes this as a safe read operation, so the description doesn't need to reiterate that. However, it adds no additional behavioral context (e.g., error conditions, authentication requirements, or pagination), which would have been valuable. It does not contradict the annotation.

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 short phrase that is concise but under-specified. It essentially restates the tool name with a space, providing no additional information beyond the name. This is more an example of under-specification than effective conciseness.

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 and an output schema), the description doesn't need to explain return values. However, it lacks any context about what an issue comment is or what comment_id refers to in the broader domain. For a get-by-ID operation, this is a moderate gap, but the output schema may partially compensate.

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 has one required parameter, comment_id, with no description and 0% schema description coverage. The tool description does not explain what comment_id is or how it should be formatted, leaving the agent to infer from the parameter name alone. This is a significant gap that the description should have filled.

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 uses a specific verb ('Get') and resource ('issue comment'), making the tool's purpose clear. It distinguishes from siblings like 'get_issue' by specifying the resource as a comment, even though it doesn't explicitly mention alternative tools.

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 is given on when to use this tool versus other issue comment operations (e.g., create, update, delete) or related get tools. The description only states what it does without any contextual usage instructions.

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