Skip to main content
Glama

db_describe

Read-onlyIdempotent

Schema inspection, list tables, show schema, table structure, columns, types — describe the project database. With no table argument, lists visible managed and raw table names with table_planes metadata. Omitted plane prefers a declared managed table; plane:"raw" inspects a same-name raw table. With a table name, returns its column names, types, constraints, and row count.

Example:

// List all tables:
{ "project_id": "my-saas" }

// Describe one table:
{ "project_id": "my-saas", "table": "users" }
// Returns: [{ "name": "id", "type": "TEXT", "pk": true }, { "name": "email", "type": "TEXT", "notnull": true }, ...]

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": {
      "project_id": "<project_id>"
    },
    "name": "db_describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
planeNoOptional database plane. The default lists both planes or prefers a declared managed table.
tableNoOptional table name; an omitted value lists all tables.
project_idYesProject ID (UUID), subdomain, or slug — resolved server-side, no UUID lookup needed. 'default' also works when the account has exactly one project; multi-project accounts must name one (the error lists them).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Beyond the readOnlyHint and idempotentHint annotations, the description discloses scoping behavior ('visible managed and raw table names with table_planes metadata') and the tie-breaking rule for the default plane. It does not discuss permission requirements for managing tables or pagination, keeping it out of 5 territory.

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?

Front-loaded with the core action, then modes, then plane nuance, then compact examples. The opening keyword list ('Schema inspection, list tables, show schema, table structure, columns, types') is slightly redundant padding but serves discoverability.

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?

No output schema exists, and the description supplies a sample return shape for the table-describe mode plus a verbal description of the listing mode output. That covers what an agent needs to call and interpret it, with only minor gaps around the exact listing payload fields.

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 already 100%, so the baseline is 3, but the description adds genuine meaning about the plane parameter's precedence and how 'table' changes the whole mode of the call. The worked examples further pin down intended usage beyond the schema text.

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 a specific verb and resource ('describe the project database') and conveys two distinct modes: listing tables versus describing one table's columns, types, constraints, and row count. It does not explicitly distinguish itself from siblings like db_query or db_dump, so it stops short of a 5.

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

Usage Guidelines4/5

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

The when-to-use logic is clearly encoded in the parameter behavior: omit 'table' to list tables, supply a name to inspect structure. The plane interaction (default prefers declared managed table, plane:'raw' inspects a same-name raw table) is spelled out, though no explicit when-not or alternative-tool routing is given.

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