get_entity_metadata

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

With no annotations, description explains the tool returns metadata (entity sets, fields, navigation properties) and implies no side effects. Could be more explicit about being read-only or requiring authentication, but sufficient.

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?

Two concise sentences: first states purpose, second gives usage guidance. No unnecessary words.

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?

Completeness is high given no output schema: describes return content and provides usage context. Could mention authentication or scope, but not critical for a metadata retrieval tool.

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 has 100% coverage for the single 'service' parameter, and description provides an example (API_BUSINESS_PARTNER) adding some value beyond the schema description.

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?

Description clearly states it fetches and summarizes OData service metadata from SAP S/4HANA, returning entity sets with key fields, properties, and navigation properties. This distinguishes it from sibling tools like execute_odata_query.

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?

Explicitly says 'Use this before calling execute_odata_query to understand the available fields and correct entity names,' providing clear context and alternative.

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