Delimit Secret Revoke

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

Beyond the destructiveHint annotation, it discloses the exact side effect: writes a revocation record via ai.secrets_broker.revoke_secret, subsequent get calls denied, and access log preserved. This is richer than the annotation and clarifies what destructive means here.

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 compact and front-loaded, then organized into labeled sections (When to use, When NOT to use, Sibling contrast, Side effects). Every sentence carries distinct information with no filler.

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?

For a single-parameter destructive tool, the description covers use cases, exclusions, sibling relationship, side effects, and downstream behavior. An output schema exists, so return-value documentation is not required here.

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 only parameter is fully described in the schema ('Secret name to revoke. Required.'), so the description does not need to repeat it. It adds no extra format or behavior details beyond the schema, matching the baseline for 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?

Opens with a specific verb and resource ('Revoke a secret to prevent any future access') and explicitly contrasts with delimit_secret_store ('creates; this disables'), which distinguishes it from the closest sibling. An agent knows exactly what this tool does.

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 when-to-use conditions ('after a credential leak or when rotating away from an old secret name') and a when-NOT-to-use condition ('to delete metadata only') with a concrete consequence (blocks delimit_secret_get). It also names the creating sibling as the alternative, leaving no ambiguity about selection.

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