vbcs_lock_application

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

Annotations already declare the tool as mutating (readOnlyHint=false), idempotent, and non-destructive. The description adds the precondition for export/import, but does not explain what locking entails (e.g., prevents edits) or permission requirements. With annotations covering safety, this is adequate but not rich.

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?

One sentence with zero waste, front-loading the action and then the key precondition in parentheses.

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?

For a simple tool with annotations covering safety and no output schema, the description explains the purpose and precondition. However, it fails to describe the required branchId parameter, leaving a gap for correct invocation.

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?

The single parameter branchId has 0% schema description coverage and is not mentioned in the description. The agent must infer that branchId identifies the application to lock, but no syntax or meaning is provided.

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?

States a specific verb 'Lock' and resource 'live application on a standalone VBCS instance', and the parenthetical clarifies the action's role relative to data export/import. The agent can distinguish it from vbcs_unlock_application by the opposite action.

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 an explicit when-to-use: 'do this before exporting/importing its data', linking it to sibling tools. It does not state when not to use or explicitly name alternatives, but the context is clear.

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