UpdateClass

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

Mentions 'Locks, updates, unlocks, and optionally activates', providing some behavioral insight, but no details on locking side effects, required preconditions, or error handling.

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?

Short description but includes redundant and contradictory phrases like 'Operation: Update, Create' and 'Will be useful for updating or creating class', wasting space.

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 information about prerequisites (e.g., transport requirements), expected return values, and potential errors. For an update tool with critical side effects, this is insufficient.

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 covers all parameters with descriptions (100% coverage). Description adds minimal extra meaning beyond naming the fields, so baseline 3 applies.

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?

Description states 'Update source code of an existing ABAP class' which is clear, but also ambiguously mentions 'Operation: Update, Create' and 'creating class', conflicting with its actual function and sibling CreateClass tool.

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?

No explicit when-to-use or alternatives provided. The description vaguely suggests it can be used for creating classes, but that is misleading as sibling CreateClass exists and schema lacks creation fields.

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