pin_repository

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

No annotations are provided, so the description must cover behavioral traits. It mentions the use of GraphQL API and required scope, but does not disclose side effects (e.g., if repo already pinned), error scenarios, or reversibility. This is insufficient for full transparency.

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?

Two sentences directly state purpose and a key requirement. No redundant words. Every sentence earns its place, making it efficient for an AI agent to parse.

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 no output schema and sparse annotations, the description should cover return values and error handling. It does not. For a mutation tool with two parameters and potential side effects, the description is too brief to be contextually 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 0% and the description adds no parameter details beyond the names 'owner' and 'repo' (e.g., what owner represents, required format). The description does not compensate for the missing schema descriptions, leaving the agent to guess parameter meanings.

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 action ('Pin a repository to a GitHub profile') using a specific verb ('Pin') and resource ('repository'), with the target identified. This distinguishes it from sibling tools like create_repository or delete_repository.

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 mentions a prerequisite ('Requires Classic PAT with write:discussion scope') but does not provide explicit guidance on when to use vs. alternatives or when not to use. The context of sibling tools suggests pinning is unique, but no exclusions are stated.

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