cml_generate_mdsl

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

No annotations are provided, so the description bears full responsibility. It discloses the generation action and the Java/CLI requirement, but does not specify side effects (e.g., file overwriting), authorization needs, or behavioral traits like idempotency or error handling. The disclosure is adequate but not thorough.

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 communicate the core purpose and a key prerequisite with no redundancy. Every word serves a purpose, making it highly concise and well-structured.

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 simple generation tool with 2 parameters and no output schema or nested objects, the description is minimally adequate but lacks guidance on usage and behavioral details. It does not explain return values or what happens to existing files, leaving some gaps.

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%, with both parameters described in the schema. The description does not add any extra semantic value beyond what the schema provides. Baseline of 3 is appropriate as the schema already documents the parameters adequately.

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 verb 'Generate', the resource 'MDSL microservice contracts', and the input 'from Context Map upstream-downstream relationships'. It effectively distinguishes itself from sibling tools that focus on adding, deleting, or generating other artifacts.

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 only mentions a prerequisite ('Requires Java 17+ and CLI') but provides no guidance on when to use this tool versus alternatives like cml_generate_context_map_diagram or cml_generate_jhipster_jdl. No exclusions or contextual usage hints are provided.

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