swarm_unlock_key

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

Annotations declare readOnlyHint=true and destructiveHint=false, and the description adds behavioral context: that a locked manager cannot serve this API request, that the key is a sensitive credential, and the exact return structure. No 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?

Front-loaded one-line purpose, followed by compact context in three sentences, each adding unique information about key usage, locked manager behavior, and security handling. 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?

With no output schema, the description explicitly states the return format. It covers preconditions (unlocked manager), use cases (autolock enabled), and security handling, making it a complete reference for a parametrized 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?

This tool has zero parameters (100% schema coverage), so the baseline is 4. The description adds a return type specification (dict with "UnlockKey") but there are no parameter semantics to clarify.

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 'Return the swarm's current unlock key' — a specific verb and resource. It distinguishes itself from sibling swarm_unlock by explaining that the result's key is fed to swarm_unlock, making its role complementary rather than ambiguous.

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: only relevant when autolock is enabled, must be called against an unlocked manager, and how the output relates to swarm_unlock. References swarm_init/swarm_update parameters for context.

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