Download OData service metadata (EDMX)

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

Annotations already disclose the broad safety profile (not read-only, destructive, idempotent). The description adds specific behavioral context: the side effect of writing to localService/metadata.xml or a custom path, automatic auth header handling for BTP destinations, and support for both V2 and V4 services. There is no contradiction with the annotations.

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 three sentences, each earning its place: the first states the core action and output, the second specifies the input modes, and the third describes the return value. It is front-loaded and contains zero filler or redundancy.

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?

For a tool with 5 optional parameters and no required ones, the description fully explains the three valid invocation patterns, the default and custom output path, and the summary return. An output schema exists, so return details are covered externally. The only minor inconsistency is 'localService/metadata.xml' vs the schema's '<workspace>/metadata.xml', but this does not compromise completeness.

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 baseline is 3. The description adds meaningful semantics beyond the schema by clarifying that serviceUrl, systemName, and destination are alternative input modes, with servicePath relative to the chosen source. This combination guidance is not evident from the individual parameter descriptions and materially helps an agent construct a valid call.

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 a highly specific verb and resource: 'Downloads the $metadata EDMX document of an OData service (V2 or V4) and saves it as localService/metadata.xml'. This clearly distinguishes it from sibling tools like get_metadata_summary or query_odata_data, which have different outputs and purposes.

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 second sentence explicitly enumerates the three supported invocation modes: direct serviceUrl, systemName plus servicePath, or BTP destination with optional servicePath. It also references sibling tools list_sap_systems and list_btp_destinations as sources for valid values, giving concrete usage guidance. It does not explicitly compare against alternatives like get_metadata_summary, but the in-tool usage context is very clear.

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