install_snippet

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

Discloses key behaviors: modifies files, conditional modification, and explicitly states 'Never corrupts user files.' Beyond annotations, it details the exact insertion point and fallback behavior, which annotations (idempotentHint=true, destructiveHint=false) do not cover.

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 with core information front-loaded. Could be split into clearer cases (HTML files vs. JSX files) but is efficient and direct.

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?

Covers the two main scenarios and what the tool returns (snippet + instructions). No output schema returned. Missing potential error cases like non-existent files, but idempotentHint suggests safe re-entry.

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 description coverage is high (83%), so schema already explains most parameters. Description adds no extra parameter details; 'accent' parameter lacks even a schema description.

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 tool inserts a cookie-banner snippet before </head> and handles files without literal </head> (e.g., Next.js) by returning instructions. This differentiates it from siblings like verify_snippet (checking) and generate_policies (creating).

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?

Explicitly indicates when to use (installing snippet) and when it does not modify (file lacks </head>). Does not directly compare to alternatives but context from sibling names implies this is the primary install tool.

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