Skip to main content
Glama

Describe Table Structure

mysql_describe_table
Read-onlyIdempotent

Retrieve column definitions for a MySQL table, including field, type, nullability, key, default, and extra info. Supports markdown or JSON output.

Instructions

Get column definitions for a MySQL table (equivalent to DESCRIBE or SHOW COLUMNS).

Args:

  • table (string, required): Table name

  • database (string, optional): Database name. Uses MYSQL_DATABASE if omitted.

  • response_format ('markdown' | 'json'): Output format (default: 'markdown')

Returns column info: Field, Type, Null, Key, Default, Extra

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tableYesTable name to describe
databaseNoDatabase name (uses MYSQL_DATABASE env var if omitted)
response_formatNoOutput format: 'markdown' or 'json'markdown
Behavior4/5

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

Annotations already provide readOnlyHint, destructiveHint, idempotentHint, openWorldHint. Description adds return column fields, output format options, and database fallback behavior, giving useful context beyond annotations.

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?

Three sentences plus a list of return columns, front-loaded with purpose. Every sentence is essential and no fluff.

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

Completeness5/5

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

Given comprehensive annotations, full parameter documentation, and clear return information, the description is complete for a read-only introspection tool.

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

Parameters5/5

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

Schema coverage is 100%, but description adds meaning by explaining the database parameter's env var fallback, response_format default, and lists return columns. Each parameter is clearly described.

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

Purpose5/5

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

Description clearly states 'Get column definitions for a MySQL table' and equates to DESCRIBE/SHOW COLUMNS, distinguishing it from siblings like mysql_show_create_table (which shows CREATE TABLE) and mysql_table_stats (statistics).

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?

Description explains parameters and default behavior for database, but does not explicitly mention when to use this tool vs alternatives. Usage is implied but not contrasted with sibling tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/donald-ada/mysql'

If you have feedback or need assistance with the MCP directory API, please join our Discord server