Skip to main content
Glama
andyWang1688

sql-query-mcp

describe_table

Retrieve detailed information about a table's structure, including columns, keys, and indexes, using a connection and table name.

Instructions

Describe columns, keys, and indexes for a table.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
connection_idYes
table_nameYes
schemaNo
databaseNo
Behavior2/5

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

No annotations are provided, so the description carries full burden. It implies a read-only operation but does not explicitly state behavioral traits like side effects, permissions, or what happens if the table does not exist.

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

Conciseness3/5

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

The description is very concise at one sentence, but it lacks structure such as a list of parameters or usage hints. It is not overly verbose, but it sacrifices completeness for brevity.

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

Completeness1/5

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

Given no output schema, no annotations, and four parameters with zero descriptions, the description is severely incomplete. The agent cannot infer return values, parameter interactions, or edge cases, making the tool hard to use correctly.

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

Parameters1/5

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

Schema description coverage is 0%, meaning the input schema has no descriptions for any parameters. The tool description adds no meaning to 'connection_id', 'table_name', 'schema', or 'database', leaving the agent without guidance on their roles or formats.

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?

The description clearly states it describes columns, keys, and indexes for a table, which is a specific verb+resource. It distinguishes from siblings like list_tables (which lists tables) and get_table_sample (which returns sample data).

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

Usage Guidelines2/5

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

No guidance on when to use this tool vs alternatives. The description does not mention exclusions, prerequisites, or scenarios where other tools like explain_query or run_select would be more appropriate.

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/andyWang1688/sql-query-mcp'

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