ise_catalog_diff

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

No annotations are provided, so the description carries the full behavioral burden. It clearly discloses 'Red-only — does NOT modify the cache,' which is critical for agents to know this is a safe read operation. It also discloses the network dependency for 'dc' (re-scraping Cisco DevNet), which is valuable behavioral context. It doesn't detail output format or failure modes, but the safety disclosure is the most important element and is well handled.

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 two sentences, efficiently packed. The first sentence states the purpose and behavior precisely, and the second sentence provides the critical read-only safety disclosure plus the network caveat. Zero wasted words or redundant phrasing.

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 diff tool with 1 optional param, fully documented schema, and a clear read-only disclosure, the description is largely complete. It explains what catalogs can be checked, what it produces (added/removed/changed entries), its non-destructive nature, and its network requirement. It could elaborate on the return/report format, but given the tool's simplicity this is not a significant gap.

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 the schema already documents the 'only' parameter ('Comma list of catalogs to check: ers,dc,openapi') and its default. The description of the tool does not add further parameter-level detail beyond what the schema provides, which meets the baseline of 3 for full schema coverage. The parameter semantics are adequately served by the schema.

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 specific verb+resource: 'Check the local catalog cache against the current upstream sources... and report added/removed/changed entries.' It clearly distinguishes this from siblings like ise_catalog_info (which presumably shows catalog content, not diffs) and the many resource-list tools. The scope is precise and unambiguous.

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 specifies when to use it (to diff local cache vs upstream) and notes that 'dc' requires network access. It doesn't explicitly name alternative tools to use instead, though siblings like ise_catalog_info are implied competitors. The network-requirement caveat for 'dc' provides useful context on when NOT to run it (offline).

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