cml_generate_glossary

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

With no annotations provided, the description does not disclose behavioral traits such as whether the tool modifies the model, reads from a specific source, or handles errors. The only behavioral info is the prerequisite Java 17+ and CLI, which is minimal for understanding side effects or constraints.

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 extremely concise with two short sentences: one for the main purpose and one for a critical prerequisite. No redundant words, and the structure front-loads the primary action.

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 tool has only 2 parameters, no output schema, and no annotations, the description covers the core purpose but lacks details on default behavior, output format, dependency on model loading, and interaction with other tools. It is adequate for a simple generation tool but not fully complete.

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 parameter descriptions for timeout and outputDir. The description does not add additional meaning beyond what the schema provides, so a baseline score of 3 is appropriate.

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 generates a ubiquitous language glossary in Markdown from the domain model using a bundled template. The verb 'Generate' and specific resource 'ubiquitous language glossary' distinguish it from sibling tools like cml_generate_aggregate_diagram or cml_generate_full_report.

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 mentions a prerequisite (Java 17+ and CLI) but does not specify when to use this tool versus alternatives like cml_generate_from_template or cml_generate_full_report. No explicit guidance on context, exclusions, or preferred scenarios.

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