Generate schema diagram

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

Description adds context beyond annotations: reveals exclusions (views, foreign tables) and default partition behavior. readOnlyHint already indicates safety, so extra detail on what is excluded is valuable.

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: two sentences and an example. No wasted words; front-loaded with 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?

Covers purpose, exclusions, return format (Mermaid string), and parameter details. With output schema present, return value is documented. Missing potential performance notes for large schemas, but overall 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?

Description explains include_partitions parameter default and effect, and gives an example for schema. Despite 33% schema coverage, it compensates by clarifying behavior for all parameters.

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 renders a Mermaid ER diagram for a schema, specifying what is excluded (views, foreign tables, partitions by default). It distinguishes from siblings like generate_graph_diagram by focusing on schema diagrams.

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 implies usage for generating schema diagrams and includes an example, but lacks explicit guidance on when not to use or alternatives. It doesn't contrast with siblings like generate_schema_docs for documentation.

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