cml_generate_jhipster_jdl

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

No annotations provided; description only states prerequisite. Fails to disclose if tool is destructive, writes files, or other behavioral traits beyond what is implicit in the name.

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?

Extremely concise (2 sentences) and to the point. No wasted words, but could benefit from slightly more detail without becoming verbose.

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?

Minimal context given the lack of output schema and annotations. Does not explain what JDL is, the output format, or any side effects. Leaves agent guessing about generated files.

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 describes all 3 parameters with 100% coverage, so baseline is 3. Description adds no additional meaning beyond schema; parameters are self-explanatory from their names and types.

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?

Describes generating JHipster JDL from domain model, a specific verb+resource. Name and description clearly indicate purpose, though doesn't explicitly differentiate from sibling generate tools.

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?

Mentions prerequisite (Java 17+ and CLI) but provides no guidance on when to use this tool versus other generate tools (e.g., cml_generate_mdsl) or when not to use it.

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