abapDocumentation

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

With no annotations, the description must communicate behavioral traits. It merely states a vague action without disclosing whether the tool is read-only, requires authentication, has side effects, or interprets parameters in any specific way.

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 short, but this is under-specification rather than effective conciseness. It lacks critical details and does not earn its brevity.

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 6 parameters, no output schema, and a large sibling set, the description is dramatically incomplete. It does not define what ABAP documentation is, what the parameters mean, or what the tool returns, leaving the agent without sufficient context to invoke it correctly.

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 description coverage is only 17%, leaving most parameters undocumented. The description adds no parameter-specific meaning; despite the presence of 'body', 'line', 'column', and 'objectUri', it fails to explain their semantics or how they influence the retrieval.

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 states 'Retrieves ABAP documentation,' which identifies a verb and resource but is vague. It does not clarify what constitutes ABAP documentation (e.g., source code comments, reference docs) nor distinguish it from many sibling tools that may also deal with documentation or source retrieval.

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 guidance is provided on when to use this tool versus alternatives like getObjectSource or searchObject. Prerequisites, context, or exclusions are entirely absent.

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