unlock_swarm

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

Annotations indicate readOnlyHint=false and destructiveHint=false, so the description must clarify behavior. It does so by stating the node resumes automatically after unlocking and that a locked node cannot serve API requests. No contradictions.

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 well-structured with a summary, detailed context, then args/returns. It is slightly verbose but every sentence adds value. Could be tightened, but overall concise enough.

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 the tool simplicity (one param, bool return), the description covers why unlock is needed, how to get key, where to call, and outcome. It mentions output schema implicitly (returns bool). Minor missing details like quorum requirements, but still complete for an agent.

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 string param 'key' with 0% description coverage. The description adds meaning: 'key - The swarm unlock key (from get_swarm_unlock_key)', telling the agent where to retrieve it. This compensates for the missing 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 unlocks a locked manager node due to autolock. It uses specific verb 'unlock' and resource 'manager node'. It distinguishes from siblings like get_swarm_unlock_key (retrieve key) and init_swarm/update_swarm (enable autolock).

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?

It explains when to use (when manager node is locked after restart) and provides explicit guidance: must be called on the locked node, and how to obtain the key via get_swarm_unlock_key. It also clarifies constraints like a locked node cannot serve API requests.

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