pin_attachment

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

The description adds no behavioral context beyond what annotations already provide (idempotentHint, readOnlyHint, destructiveHint). It does not explain side effects, required permissions, or behavior when pinning an already pinned attachment.

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, making it very concise. It lacks any structure but for a simple action, this is acceptable. Minor improvement could include listing the two states or referencing the pinned parameter.

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?

The description does not explain what pinning an attachment means in the application context (e.g., making it appear at the top of a list). Given no output schema and 2 parameters, more context is needed to fully understand the tool's effect.

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 describes both parameters (pinned as boolean, attachmentId as string) with clear descriptions. The description adds no additional meaning beyond the schema, so baseline score of 3 is appropriate given 100% 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 or unpin an attachment' clearly states the specific action (pin/unpin) and resource (attachment). It distinguishes the tool from siblings like add_attachment or update_attachment by focusing on the pinning action.

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 provides no guidance on when to use this tool versus alternatives (e.g., add_attachment for adding, update_attachment for updating). It does not mention prerequisites or context for pinning/unpinning.

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