Skip to main content
Glama
sql-analyst
by Yehiak

Describe table

describe_table
Read-onlyIdempotent

Returns a table's columns with data types, documented meanings, and sample values to clarify how values are spelled and support accurate query writing.

Instructions

Columns of one table: type, meaning (when documented) and a few common values, which show how values are spelled (e.g. 'delivered', 'SP').

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "table": "<table>"
    },
    "name": "describe_table"
  }
}

Input Schema

NameRequiredDescriptionDefault
tableYesTable name from list_tables.

Output Schema

NameRequiredDescriptionDefault
nameYes
columnsYes
descriptionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the bar is low. The description still adds real nuance beyond them: 'meaning' is only present 'when documented' (partial metadata) and only 'a few common values' are shown, signalling the sample is illustrative rather than exhaustive.

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

Conciseness4/5

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

One compact sentence with no filler, and the useful caveats are attached inline to the fields they qualify. It reads as a fragment rather than a full statement of action, which costs a little clarity but wastes nothing.

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?

An output schema exists, so return values need not be spelled out, and the single parameter is fully documented in the schema. What remains worth saying — that metadata may be undocumented and sample values are partial — is covered, leaving only edge cases like unknown table names unaddressed.

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?

There is a single parameter and schema description coverage is 100%, with the schema already stating it is a table name sourced from list_tables. The description contributes nothing further about the parameter, so the baseline of 3 applies.

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?

States precisely what the tool returns — the columns of a single table with type, documented meaning, and sample values that illustrate spelling. The verb itself is carried by the name/title rather than the description, and there is no explicit contrast with list_tables or run_sql, but the resource and payload are unambiguous.

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?

No explicit when-to-use or when-not-to-use statement and no named alternatives; the only routing hint ('Table name from list_tables') lives in the schema, not the description. Usage is only implied by the mention of how values are spelled, which suggests checking columns before filtering.

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

Deploy Server

Other Tools