lock_adom

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

No annotations provided, so the description carries full burden. It discloses the basic behavior (locks ADOM, returns status/message) and includes a usage pattern. It does not specify idempotency or error handling for already locked ADOMs, but for a simple lock tool, the description is adequate.

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 efficient: a brief one-sentence purpose, then structured Args/Returns/Example. Every part adds value without 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?

Given the tool's simplicity and the presence of sibling unlock_adom and commit_adom, the description provides a complete workflow. The return format is defined, and the example illustrates typical usage. No output schema needed.

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% description coverage, and the description adds clear meaning: 'ADOM name to lock'. The single parameter is well-defined, and the example shows usage with 'root'.

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 'Lock an ADOM for editing' using a specific verb and resource. It distinguishes from siblings like unlock_adom by specifying 'workspace mode' and the prerequisite for changes.

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?

The description explains when to use: 'In workspace mode, ADOMs must be locked before making changes' and hints at conflict prevention. It provides an example that includes commit_adom and unlock_adom, implying a workflow, but does not explicitly state when not to use or list alternative tools.

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