UpdateServiceDefinition

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

No annotations are provided, so the description must fully communicate behavioral aspects. It only mentions 'Uses stateful session with proper lock/unlock mechanism', hinting at transaction-like behavior but not clarifying if the operation is safe, destructive, or what happens on failure. Side effects, permission requirements, and output (if any) are omitted.

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 very concise with two short sentences, conveying the core action and a key behavioral trait (stateful session). However, it sacrifices completeness for brevity, missing important context like error handling or prerequisites.

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 no output schema, no annotations, and 4 parameters, the description is incomplete. It fails to explain what the tool returns, when it fails, or how to properly use it with the transport request. The mention of stateful session is helpful but insufficient for safe 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?

All 4 parameters have schema descriptions (100% coverage), so the schema already documents their semantics. The description adds no additional meaning beyond stating 'source code'. Baseline 3 is appropriate as the description does not compensate for any missing schema detail.

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 the action ('Update source code') and the resource ('existing ABAP service definition'), distinguishing it from other Update* siblings (e.g., UpdateClass, UpdateBehaviorDefinition). It specifies that the service definition must exist, which is explicit enough for selection.

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 does not provide explicit guidance on when to use this tool versus alternatives (e.g., when to update source code vs behavior definition). It mentions a 'stateful session' but no context on when this session is required or how it interacts with other operations. No 'when-not-to-use' information is given.

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