openclaw_update_run

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

Discloses destructive behavior and potential session interruption, filling the gap due to missing annotations. Could elaborate on return value or async behavior, but current disclosure 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?

Three concise sentences: purpose, wrapping detail, and warning. Efficiently front-loaded with no unnecessary content.

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?

Lacks return value description (no output schema). Does not explain if it prompts for confirmation or returns a status. Could be more complete for a destructive operation.

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 100%, so baseline is 3. Description adds minimal value beyond schema: references 'latest version' aligns with `version` param. No extra semantics for `instance` param.

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?

Clearly states the tool triggers an update by pulling the latest version and restarting components. Specifies it wraps `update.run`, and among sibling tools, none perform the same function, making its purpose distinct.

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?

Explicitly warns that the call is destructive and may interrupt sessions, advising confirmation. No explicit comparison to alternative tools, but the warning sufficiently guides appropriate use.

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