Skip to main content
Glama

describe_table

Read-onlyIdempotent

Retrieve a table's schema and row count to inspect its structure and size, with optional workspace targeting.

Instructions

Return the schema and row count of 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
workspaceNoNamed workspace. Omit to use the default workspace.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world, so the safety profile is fully covered externally. The description's added value is naming the return payload (schema plus row count), which matters because no output schema exists; however, it omits whether the row count is exact or approximate and whether it is expensive on large tables. That is a real gap for a tool that may scan a whole table.

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 front-loaded sentence with zero filler, stating the effect before any detail. It is efficient, though the terseness leaves little room for the clarifying detail noted elsewhere.

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 simple two-parameter read tool with strong annotations, the description covers what is returned, which is important given there is no output schema. It falls short on the identifier format for the one required parameter and on any cost or accuracy caveat for the row count.

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

Parameters2/5

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

Schema coverage is only 50%: the 'workspace' parameter is documented in the schema, but the required 'table' parameter has no description at all, and the description does not compensate by explaining the expected identifier form (bare name, fully qualified name, or ID). With half the parameters undocumented, the description needed to do more than restate 'one table'.

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?

A specific verb ('Return') plus a specific resource ('schema and row count of one table'), which is unambiguous and clearly distinct from siblings like drop_table or sample_table. It stops short of naming any alternative, but the operation itself is stated precisely.

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 guidance on when to call this versus list_tables (discover names) or sample_table (inspect data), nor any stated prerequisites such as the table needing to exist. Usage is only inferable from the phrase 'one table'.

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