odata_metadata

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

With no annotations, the description carries the full burden and does so well: it discloses that entity="" output is large (hundreds of entity types), that the full map is written to a JSON file with a small map returned inline, that navigation resolution is fetched once per company_id per process then cached, and that a lookup failure surfaces as a warning without blocking field output.

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 core behavior is front-loaded in the first sentence, and the remaining paragraphs are organized by concern (scope, caching, failure handling, v4 paths). It is longer than strictly needed — several parentheticals could be trimmed — but no sentence is pure filler.

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 two-parameter metadata tool with an output schema already present, the description covers the non-obvious behaviors an agent needs: output size, file-vs-inline return, caching key, non-blocking warnings, and v4 path semantics. Nothing material is left for the agent to infer.

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 the description must compensate: it fully explains entity's two modes and the v4 service-path form ('talent/cdp/Learning.svc/v1' or root plus entity set). company_id is only implied through the caching note ('once per company_id per process') and is never defined, leaving one parameter under-explained.

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?

States a specific verb and resource ('Fetch OData $metadata (EDMX) and reduce it to a compact field map') and clearly delimits scope via the entity parameter. An agent can distinguish this metadata-inspection tool from compare_metadata and odata_query without opening the schema.

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?

Gives concrete context: entity="" for the whole service, entity="EmpJob" for one set, and explicitly routes the agent to use navigation names to scope $filter into other entities rather than pulling whole sets. It points at odata_query and the server's 'Scope with EmpJob first' guidance, though it never states an explicit when-not-to-use condition.

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