spring_flyway_risk_scan

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

No annotations are provided, and the description does not disclose behavioral traits such as read-only vs. destructive nature, or what constitutes a 'risky operation'. The minimal description offers little beyond the purpose, leaving the agent uninformed about side effects or requirements.

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 a single, front-loaded sentence with no extraneous information. It is concise but at the expense of completeness.

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 the lack of an output schema and minimal annotations, the description does not provide sufficient context for an agent to understand the tool's behavior fully. The agent cannot infer what the scan returns, what risks are detected, or how the output is structured.

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?

The input schema has two parameters: 'path' and 'format'. Only 'path' has a description ('Project directory to scan.'); 'format' lacks a description, resulting in 50% schema coverage. The tool description adds no additional meaning beyond the schema, failing to explain the format parameter's purpose or acceptable values.

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 'Scan Flyway SQL migrations for risky operations' clearly states the verb (scan) and resource (Flyway SQL migrations), making the tool's purpose understandable. However, it does not differentiate from the sibling tool 'inspect_flyway_migrations', which likely has a similar scope.

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?

There is no guidance on when to use this tool versus alternatives like 'inspect_flyway_migrations'. The description fails to provide context about when this scan is appropriate or when it should be avoided.

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