GetPackageContents

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

With no annotations provided, the description must disclose behavioral traits. It only states the tool is read-only and supports recursion. Missing details include pagination, size limits, permissions, or side effects. The description is insufficient for an agent to fully understand the tool's behavior.

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, consisting of a single sentence plus a prefix. It is front-loaded with the read-only hint. However, given the tool has 4 parameters and no output schema, the description could be slightly more detailed without losing conciseness.

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 tool has 4 parameters and no output schema or annotations. The description fails to cover important aspects like default behavior, return object types, or potential performance considerations. An agent lacks sufficient context to use the tool effectively.

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 input schema covers all 4 parameters with descriptions. The description adds no extra meaning beyond the schema; it only reiterates 'recursive traversal' which aligns with existing parameters. As schema coverage is 100%, a baseline of 3 is appropriate.

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 'Retrieve objects inside an ABAP package as a flat list', which is specific and includes the output format. The '[read-only]' prefix adds clarity. However, it does not differentiate from siblings like GetPackageTree, which might return objects in a tree structure.

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 guidance on when to use this tool versus alternatives. It mentions support for recursive traversal but lacks explicit or implied context for selecting this tool over other listing tools (e.g., GetObjectsList, GetPackageTree).

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