compare_metadata

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

With no annotations, the description carries the full behavioral burden and does so well. It states that the comparison runs remotely, not in the conversation, and details the return shape: in_sync, per-entity missing fields, and differing attributes as [value_in_a, value_in_b]. It even explains which attributes matter and why, giving the agent real operational insight.

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 front-loaded with the core purpose, then adds parameter behavior, then returns and edge-case meaning. Every sentence earns its place, including the size rationale and the sap: attribute explanation, without becoming bloated.

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 comparison tool of this complexity, the description covers what the tool does, how it behaves, what its main parameter controls, and what the output means. An output schema exists to supply formal return-field definitions, so nothing critical is missing for an agent to select and invoke the tool 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 the description must clarify the parameters. It fully documents the non-obvious entity parameter with an explicit example and the empty-string whole-service case, and it maps company_a and company_b to the two instances being compared. For three simple parameters, this is sufficient.

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 opening line states a precise operation—compare the OData configuration of two instances—and names the result: drift. It is clearly distinct from siblings like odata_query and odata_metadata, which are single-instance read/query tools.

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 guidance on entity scope: comparing one entity set versus the whole service. It also explains why the tool should run the comparison instead of doing it in-conversation, using a concrete size rationale. It does not explicitly name sibling alternatives or when-not-to-use cases, but the context is clear enough.

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