secret_remove

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

Annotations already indicate destructiveHint, but the description adds important subtle behavior: removal does not immediately affect running service tasks; they retain access until restarted/updated. This is valuable context that goes beyond the annotation and helps set expectations without contradiction.

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 front-loaded with purpose, followed by behavioral nuance and a structured args/returns block. Each sentence earns its place; the second paragraph is slightly long but provides necessary detail on removal semantics.

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, a bool output schema, and annotations, the description covers all essential aspects: purpose, prerequisite, side-effects, parameter meaning, and return value. The inclusion of helper tool references makes it self-contained and practically complete.

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 input schema has zero description, but the description compensates by explaining that id_or_name accepts either a secret id or name. This clarifies the parameter's flexibility and purpose beyond the bare schema definition.

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 'Remove a Swarm secret' using a specific verb and resource. It is clearly distinguished from sibling secret tools like secret_create, secret_inspect, and secret_list, which handle other operations.

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 pre-removal guidance: use service_list and service_inspect to identify services mounting the secret, and notes that service filters don't support secret reference. The 'requires a swarm manager' line sets a prerequisite but doesn't explicitly contrast with alternatives in terms of when not to use this tool.

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