SAP Chat Read All

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

The description claims a read operation, but annotation readOnlyHint=false indicates the tool may have side effects, contradicting the implied behavioral safety. Additionally, no side-effect or permission details are disclosed beyond the contradiction.

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 a single, complete sentence (13 words) that immediately identifies the action and sources. No redundant or unnecessary details.

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 the tool's complexity (5 parameters, output schema present) and available annotations, the description is minimal and omits context like usage scenarios or implications of the data sources. It is adequate but not thorough.

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 100%, so the schema fully documents parameters. The description adds no parameter-level information beyond what the schema provides, meeting the baseline 3.

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 ('Read all SAP chat messages') and the specific sources ('sealed ledger pages plus the latest ring buffer'), effectively distinguishing it from siblings like sap_chat_read_latest which likely returns only latest messages.

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 implies usage for retrieving full message history but does not explicitly state when to use this tool versus alternatives like sap_chat_read_latest. No exclusions or when-not guidance is provided.

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