cml_generate_full_report

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

With no annotations, the description must disclose behavioral traits. It only states it generates documentation; does not mention side effects, whether it reads or modifies state, output naming, or error behaviors. The prerequisite is system-level, not behavioral.

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 concise (single sentence) and front-loads the core purpose. However, it sacrifices completeness for brevity, missing important details that an agent would need.

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 two optional parameters and no output schema, the description lacks details on return values, file naming, prerequisites beyond Java/CLI, and error scenarios. An agent cannot fully understand the tool's behavior from this description alone.

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 descriptions for both 'timeout' and 'outputDir'. The tool description adds no additional meaning beyond schema, but baseline for high coverage is 3. No clarification on default values or usage context.

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 comprehensive domain documentation in Markdown using a bundled template. It distinguishes from siblings like cml_generate_full_diagram (diagrams) and cml_generate_glossary (subset), but does not explicitly differentiate from other generation 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?

No guidance on when to use this over alternative generation tools. The only usage hint is a system prerequisite (Java 17+ and CLI), which is not sufficient for tool selection decisions.

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