drift_check

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

Describes output as reporting added/removed tables/columns/relations. Does not specify output format or permissions, but implies read-only behavior. Lacks explicit side-effect disclosure (safe).

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?

Two sentences: first defines functionality and inputs, second gives usage advice. No redundant words, highly efficient.

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?

Covers input types, output type (additions/removals), and usage scenario. Lacks output format details and error handling, but sufficient for its simplicity.

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 covers 67% of params with descriptions. Description adds context for doc_path and schema_path (file containing diagram vs schema source). Schema_type enum values not described, but enum limits choices. Adequate but not enhanced.

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?

Clearly states the tool checks ERD drift between a doc and current schema, specifying file types (.mmd, .md with mermaid) and reporting additions/removals. Distinguishes from sibling tools (render, convert) by focusing on verification.

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?

Provides explicit usage context: 'Use this in CI or before shipping docs.' Implicitly guides away from render/convert tasks. Could be improved by stating when not to use (e.g., for non-ERD content).

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