Check Schema Drift

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

The readOnlyHint annotation is true, and the description aligns with that by noting the check operation. The description adds valuable behavioral context by stating the requirement for project context and the mutual exclusivity of the two parameters. It could have added more about what the output looks like or how drift is reported, but the annotation already covers the safety profile.

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 concise, well-structured, and front-loaded with the core purpose. It then explains the two modes in a clear, logical sequence, followed by the constraint and prerequisite. Every sentence contributes essential information without redundancy.

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?

Given that there is no output schema, the description could have been slightly more explicit about the return value (e.g., a list of drifted fields or a boolean). However, the description covers purpose, modes, constraints, and context requirements, which is sufficient for an agent to select and invoke the tool correctly in most cases.

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 coverage is 100%, and the description reinforces the critical parameter semantics, especially the mutual exclusivity of testCaseId and specId and the meaning of checkAgainstLinkedVersion in single mode. The description adds interpretive value beyond the raw schema by clarifying the mode selection logic, which is the most important semantic aspect here.

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 clearly states the tool's purpose: checking for schema drift between a test case's linked endpoint snapshot and the current spec. It also distinguishes between two distinct modes (single test case vs. batch check for all linked test cases of a spec), which differentiates it from sibling tools like get_schema_drift_report or get_contract_drift.

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 explicitly explains the two modes and how to invoke each: provide testCaseId for single mode or specId for batch mode. It also clearly states the constraint that exactly one of testCaseId or specId must be provided, and notes that project context is required. This is excellent routing guidance relative to alternatives.

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