Replace String in ABAP Object

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

The description adds behavioral details beyond annotations: it describes the fresh read, under-lock compare before saving, and the return of SAP syntax diagnostics. This complements the destructiveHint=true annotation, though it could elaborate on transactional behavior 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?

The description is extremely concise with two sentences: the first states the core action and method, the second adds return information and a prerequisite. No redundant or vague statements.

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?

The description covers the main action, process, return type, and transport requirement, but lacks details on parameter behavior (e.g., 'activate'), error scenarios, or output structure. For a tool with 6 parameters and no output schema, more context is needed for full agent comprehension.

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?

With 0% schema coverage, the description does not explain individual parameters like 'activate' or 'connectionId'. It implies the role of 'oldString' and 'newString' and mentions 'transport' for non-local packages, but leaves several parameters undocumented, reducing semantic clarity for the agent.

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 tool replaces exactly one source fragment in an ABAP object. It specifies the verb 'replace' and the resource 'source fragment', and distinguishes itself from sibling tools like refactor_abap_code by emphasizing single-fragment operation with locking behavior.

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 explains that the tool is for replacing a single source fragment with a fresh read and lock-compare. It also notes that non-local packages require a transport, providing usage context. However, it does not explicitly state when not to use this tool or mention alternatives.

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