get_service_metadata

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

The description carries the full burden here because no annotations exist, and it discloses genuinely useful behavior: results are cached for 7 days, raw=true returns a very large EDMX payload (a performance warning), and refresh forces re-download. It does not say whether this is read-only, what auth is required, or how caching interacts with refresh. This is good but incomplete disclosure for an unannotated tool.

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?

Compressed into roughly three short clauses that are front-loaded with the return shape, followed by the important warnings about raw and refresh. No filler, though the fragmentary telegraphic style (no verb in the opening clause) costs some readability.

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?

An output schema exists, so return values need not be explained, and the description usefully covers caching and the raw mode. However, for a four-parameter tool with zero schema documentation, the description leaves the required service identifier and the entity format unspecified, which an agent needs in order to call 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 0%, so all four parameters rely entirely on the description. raw, refresh, and (partially) entity get meaning, but the required 'service' parameter is never explained: it is unclear whether it takes a service name from list_services or a URL or path. The accepted format for entity is also unstated. Half the parameters remain ambiguous.

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 names the resource (OData service structure) and its two modes of return: entity sets for the whole service, or keys and fields for a single entity. The verb is implied rather than stated (it is a fragment, not a sentence), but an agent can still tell it apart from list_services and describe_sap_table. It is specific enough to select correctly.

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?

There is clear guidance on two parameters: use raw=true only if you need the full EDMX, but avoid it because the result is very large, and refresh re-downloads. There is no explicit statement of when to use this rather than list_services (which presumably yields the valid 'service' values) or describe_sap_table, so the routing guidance is implied and not stated.

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