github_issues_pin_comment

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

No annotations are provided, and the description does not disclose any behavioral traits. It does not mention effects like whether multiple pins are allowed, if it replaces existing pins, or any permission requirements. The agent is left without critical context for safe invocation.

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, which is concise. However, it is too brief and sacrifices necessary explanatory context. While there is no wasted text, the terse style undermines completeness, placing it at an average score.

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 lack of annotations and output schema, the description should provide more context about the operation's effects and constraints. It does not mention that the comment must belong to an issue in the specified repo, or that only one comment can be pinned per issue. This is insufficient for a mutation tool.

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 100% description coverage for its three parameters (owner, repo, comment_id), so the schema already provides the meaning. The description adds no further parameter information. This meets the baseline for a tool with full schema coverage.

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 'Pin an issue comment' is a clear verb+resource combination. It immediately conveys the action (pin) and the target (issue comment), making the tool's purpose understandable. However, it lacks context about what pinning means in GitHub (e.g., highlighting it), which would improve clarity further.

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 provided on when to use this tool versus alternatives. There is a sibling tool 'github_issues_unpin_comment', but no reference to it. The description does not specify scenarios or prerequisites, such as needing write access to the repo.

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