Skip to main content
Glama

Export Schema DDL

export_schema_ddl
Read-onlyIdempotent

Exports SHOW CREATE TABLE DDL for one table or every base table, enabling MySQL schema capture for migration, review, or version control.

Instructions

Export SHOW CREATE TABLE DDL for one table or every base table.

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": "export_schema_ddl"
  }
}

Input Schema

NameRequiredDescriptionDefault
jdbc_urlNoOptional JDBC URL to target a specific database (credentials embedded in URL); uses environment default when omitted
table_nameNoOptional plain table name; omit to export every base table

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.1
    • addedInput schema / properties / jdbc_url
      Added value: +{
      +  "description": "Optional JDBC URL to target a specific database (credentials embedded in URL); uses environment default when omitted",
      +  "type": "string"
      +}
  2. First observedv1.0.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds only the output-artifact detail (DDL text, all base tables when unfiltered). It says nothing about permissions needed, whether views/system tables are excluded, or output size for large schemas.

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?

A single, front-loaded sentence with no filler. The scope distinction (one table vs. all base tables) is stated immediately and nothing is redundant.

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

Completeness4/5

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

This is a simple read-only export with two optional parameters and no output schema, and the description conveys what is produced and how scope is controlled. Minor gap: it does not indicate the shape of the result (e.g., single DDL string vs. per-table map), which would matter when exporting every base table.

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

Parameters3/5

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

Schema coverage is 100%, so both jdbc_url and table_name are already documented, including the embedded-credentials behavior and the omit-to-export-all default. The description restates the table_name semantics but adds nothing new about jdbc_url or connection overrides.

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?

The description names a specific verb (Export) and a specific artifact (SHOW CREATE TABLE DDL), plus the scope (one table or every base table). An agent can tell exactly what comes back. It does not, however, distinguish this from sibling tools like describe_table or analyze_schema_normalization, so it falls short of a 5.

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?

The phrase 'for one table or every base table' implicitly tells the agent how to select scope via table_name, but there is no explicit when-to-use guidance or named alternative (e.g., use describe_table for column metadata instead). Usage is inferable rather than stated.

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