Skip to main content
Glama

describe_table

Get column names and types, row count, sample rows, and data-quality flags for one hospital table to understand its structure before writing queries.

Instructions

Columns (name and type), row count, three sample rows, and which columns are data-quality flags, for one table.

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
tableYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations supplied, the description carries the full burden, and it does disclose the return payload — including that sample rows are capped at three, which usefully signals sampling rather than full data. However, it never states that the operation is read-only, what happens for a nonexistent or unauthorized table, or whether sampling has cost/latency implications for large tables.

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?

A single dense sentence where every clause adds information about the returned content, with the most useful part (column metadata) front-loaded. It is efficient, though leading with the resource and verb would orient the reader marginally faster than leading with 'Columns'.

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?

For a one-parameter tool with no annotations and no output schema, the description does the important work of enumerating return values, which is the main gap it needed to fill. It falls short on table-name discovery, error behavior, and explicitly stating the read-only nature of the operation.

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?

Only one parameter exists and schema description coverage is 0%, so the schema offers no meaning for 'table'. The description partially compensates by saying 'for one table', implying the parameter is a single table identifier, but gives no format guidance such as schema-qualification or case sensitivity.

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 resource ('one table') and enumerates exactly what the tool yields: column names and types, row count, three sample rows, and data-quality flag columns. It is clearly a describe/inspect operation distinct from list_tables or query, though it is phrased as a noun list rather than a verb+resource statement.

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?

There is no when-to-use guidance, no mention of when to prefer this over query or overview, and no note that list_tables can supply valid table names. The only implicit signal is the scope phrase 'for one table', which tells the agent this operates on a single table but nothing about prerequisites or alternatives.

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