paperclip_request_revision

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

Discloses board-only usage, required API key, and error handling for various HTTP statuses. Annotations (destructiveHint=false) are consistent; description adds significant context about state changes and permissions.

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?

Well-structured with clear sections (Args, Returns, Examples, Error Handling), front-loaded with purpose, and no unnecessary details.

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, description explains return value and status. Covers error codes, required auth, and state constraints. Adequate for the tool's complexity.

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 covers both parameters with descriptions. Description adds example for approvalId format and clarifies feedback as optional, adding value beyond 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?

Clearly states it requests a revision on a pending approval, returning it to the requester. Distinguishes from sibling 'paperclip_reject' by explicitly saying when not to use it.

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?

Provides explicit use cases (e.g., a hire proposal before board approval) and when not to use (outright denial, use paperclip_reject). Also mentions board-only requirement and API key needs.

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