odata_metadata

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

With no annotations, the description carries the full burden of disclosure. It transparently reveals that the full map is written to a JSON file, that a 'small map' is returned inline, and that raw EDMX is never loaded into the conversation. This gives an agent a clear model of side effects and output behavior.

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 compact and front-loaded with the primary action, followed by parameter semantics and output behavior. Each sentence adds meaningful information; only minor redundancy in the two-map explanation prevents a perfect score.

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 value details are handled. The description covers the entity parameter and the file side-effect, but the unexplained company_id and lack of any guidance about tenant/service context leaves the tool not fully self-contained for correct invocation.

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 document parameters. It explains entity behavior well (empty vs specific value), but company_id is completely unexplained, leaving half of the parameters ambiguous. Partial compensation prevents a lower score.

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 opens with a clear action and resource: 'Fetch OData $metadata (EDMX) and reduce it to a compact field map.' It distinguishes the tool from siblings by stating it produces a reduced map rather than raw EDMX or query results, and the entity-specific example reinforces its purpose.

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 gives clear internal guidance for when to use entity='' versus entity='EmpJob', and hints at a comparison use case. However, it does not explicitly state when to choose this tool over siblings like odata_query or compare_metadata, leaving the selection partly implied.

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