remove_secret

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

Beyond annotations (destructiveHint=true), describes that tasks with the secret retain access until restarted or service updated, and that secret id is required. Adds significant behavioral context.

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, front-loaded with core purpose, then detailed implications and prerequisites. Every sentence adds value with no 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?

With one parameter, annotations, and output schema, the description covers all aspects: return value (bool), prerequisites, side effects, and parameter source. Complete for a destructive tool.

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 has 0% coverage, but description fully compensates: explains secret_id parameter is the id (not name), and tells how to obtain it from list_secrets or get_secret. Adds essential meaning.

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 'Remove a Swarm secret' with specific verb and resource. It distinguishes from siblings like create_secret and list_secrets by specifying the action and requirement of a swarm manager.

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 guidance: use list_services and get_service to check secret usage before removal, and explains that removal doesn't immediately affect running tasks. Also advises retrieving secret id from list_secrets or get_secret. Lacks explicit 'when not to use' but covers critical prerequisites.

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