iyke_lock_acquire

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

With no annotations, the description carries full burden and discloses key behavior: holder must come from iyke_agent_register, ttl_ms defaults and clamping, and wait_ms blocking behavior.

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?

Five sentences efficiently cover purpose, usage, and key parameter behaviors without fluff, front-loading the core action.

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 5 params, no output schema, and no annotations, the description covers purpose, usage, and most parameter behavior. Missing details on 'scope', 'resource', return value, and error cases, but still fairly 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?

Schema coverage is 0%, so description must compensate. It explains holder, ttl_ms (defaults/clamping), and wait_ms (blocking), but does not clarify 'scope' or 'resource' beyond the name.

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 it acquires a project-scoped lease lock on a named resource, which distinguishes it from the sibling tool 'iyke_lock_release' and other coordination tools.

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 provides clear usage context ('short-lived coordination around shared files, plans, migrations') and ties to a sibling ('iyke_agent_register'), but does not explicitly state when not to use or compare to 'iyke_lock_renew'.

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