Skip to main content
Glama

data-api-code

sql_ddl_to_mermaid_er

Parse SQL CREATE TABLE DDL statements (columns, PK, FK REFERENCES) into a Mermaid erDiagram schema and normalized table inventory.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "sql_ddl_to_mermaid_er"
  }
}

Input Schema

NameRequiredDescriptionDefault
textNo
filePathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior2/5

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

With no annotations at all, the description carries the full burden and does little beyond restating the transformation. It says nothing about how multiple statements are handled, whether unsupported DDL clauses are silently dropped or error out, or whether output is deterministic — all material for a parser.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

One dense sentence that front-loads the input, the extracted pieces, and the two outputs. Every clause carries information and there is no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The transformation is fully described and no output schema exists to explain return values, so the return side is adequately covered. However, with two undocumented optional parameters and no annotations, the definition leaves the input-selection question unaddressed relative to the tool's actual ambiguity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and the description never mentions either parameter. The two inputs, text and filePath, are both optional with no stated precedence, so an agent cannot tell which to supply or what happens if both are given — the core ambiguity of this tool is left undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb (parse) and resources (SQL CREATE TABLE DDL, Mermaid erDiagram, table inventory), and even enumerates the extracted elements (columns, PK, FK REFERENCES). What is missing is any explicit contrast with the closest sibling, sql_format_and_lint, so the agent must infer that this tool draws diagrams rather than reformat SQL.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: an agent can deduce it should call this when it wants an ER diagram from DDL. There is no statement of when to prefer it over sql_format_and_lint, nor any exclusion (e.g., that other DDL constructs are ignored), leaving the routing decision to inference.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources