Generate ER HTML

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

No annotations are present, so the description should cover behavioral traits. It mentions 'allowed metadata' but does not clarify permissions, side effects, or what the tool returns (e.g., HTML string vs. file). This is insufficient for a tool with 13 parameters.

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 single-sentence description is concise but under-specified. It omits critical details about parameters, output, and usage, making it more incomplete than concise.

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's complexity (13 param, no annotations, no output schema), the description is vastly incomplete. It lacks information on how parameters affect behavior, what the output format is, and any prerequisites or limitations.

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 description does not explain any of the 13 parameters. With 0% schema coverage, the burden is on the description to provide parameter semantics, and it fails entirely.

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 self-contained HTML ER diagram from OceanBase metadata. However, it does not differentiate from sibling tools like ob_generate_er_diagram or ob_generate_entity_diagram, which may produce similar outputs.

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 is provided on when to use this tool versus alternatives. With many similar diagram-generation siblings, explicit usage context is missing.

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