Skip to main content
Glama

Describe a table

tables.describe
Read-onlyIdempotent

Columns, primary key, foreign keys, indexes, row level security and policies of one table. Scope: database:read.

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": "tables.describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
tableYesTable name
branchNoBranch (environment) id. Optional: defaults to `production`.
schemaNoSchema, default `public`
project_idNoProject id. Optional: defaults to the project created or used last in this session, or the only one.
organization_idNoOrganization id. Optional: defaults to the token's organization, or the only one you belong to.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered. The description adds the scope string "database:read" plus the enumerated return contents, but says nothing about behavior on missing tables, permission failures, or how branch/schema defaults resolve.

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?

Two short clauses, zero filler: returned attributes are front-loaded and the scope constraint follows. Every phrase carries information and nothing merely restates the title.

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?

For a read-only introspection tool with full schema coverage and annotations, the description covers what is returned and the required scope. The remaining gap is no mention of error behavior or how branch/schema defaults combine when resolving the table.

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

Parameters4/5

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

Schema coverage is 100%, so branch, schema, project_id, and organization_id defaults are already documented in the schema, giving a baseline of 3. The description adds some value by framing the result as one table while parameters include branch and schema, hinting at how the lookup is qualified, though it doesn't spell out how table, schema, and branch interact.

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 states precisely which metadata is returned for a single table: columns, primary key, foreign keys, indexes, row-level security, and policies. That is a specific resource-plus-attributes statement; the sibling tables.list implies the single-vs-many distinction, though the description never explicitly contrasts them.

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 explicit when-to-use guidance and no named alternative; the agent must infer from names alone that tables.list enumerates tables while this inspects one. It also doesn't say when to prefer database.query, sql.explain, or tables.list for schema investigation.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources