secret_remove

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

Annotations indicate destructiveHint=true, so destructive nature is clear. Description adds valuable context: removal doesn't immediately affect running tasks; tasks retain access until restart or service update. This goes beyond annotations by explaining the delayed effect.

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?

Description is well-structured: first sentence states purpose, second paragraph provides behavioral details and guidance, third paragraph lists args/returns. It is front-loaded and efficient, though the second paragraph could be slightly more concise without losing clarity.

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 low complexity (1 parameter), the description covers prerequisites, side effects, impact on services, and return value. It also provides cross-referencing to related tools (service_list, service_inspect). No output schema exists, but return type is described. Fully adequate for an agent to use the tool correctly.

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 one required parameter with 0% coverage, so description must compensate. It states 'id_or_name - The secret id or name to remove', adding basic meaning beyond the schema's type-only definition. However, no further format or constraints are provided, meeting the minimum viable level.

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 removes a Swarm secret and requires a swarm manager. It uses specific verb 'Remove' and resource 'Swarm secret', distinguishing it from sibling tools like secret_create, secret_inspect, etc.

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?

Explicit guidance is given: requires swarm manager, explains that removal does not affect running tasks immediately, and advises using service_list and service_inspect to identify affected services. Also notes that service filters do not support secret reference filtering, providing clear when-to-use and when-not-to guidance.

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