link_pin_deploy

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

With no annotations provided, the description carries the full burden for behavioral disclosure. It reveals the overwrite behavior on re-runs, which is a key trait, but does not cover authentication requirements, error states (e.g., invalid annotationId), or the extent of side effects beyond the dashboard display.

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 three sentences long, front-loaded with the core action. Every sentence contributes essential information without redundancy.

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 output schema and three parameters, the description adequately covers the tool's purpose, typical invocation context, and idempotency behavior. It lacks details on error handling or return values, but the tool's simplicity makes this acceptable.

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?

All three parameters have descriptions in the schema (100% coverage), so the description adds limited extra meaning. It provides context ('Typically called by the deploy-hook...') but does not enrich the parameter semantics beyond what the schema already offers.

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 opens with 'Link a deploy URL to a resolved pin', which is a specific verb+resource combination. It clearly distinguishes this tool from its many siblings by focusing on a unique linking 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 explicitly states it is 'Typically called by the deploy-hook edge function once a deploy that includes the pin's fix goes live', providing clear usage context. It also notes that re-runs overwrite previous URLs, implying idempotent behavior, but doesn't mention when not to use it or alternatives.

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