Skip to main content
Glama

Describe Database Table

describe_table
Read-onlyIdempotent

Inspect a database table to reveal its columns, data types, keys, and defaults, helping you verify schema structure before querying or modifying data.

Instructions

Describe the columns, types, keys and defaults of a database 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_name": "<table_name>"
    },
    "name": "describe_table"
  }
}

Input Schema

NameRequiredDescriptionDefault
jdbc_urlNoOptional JDBC URL to target a specific database (credentials embedded in URL); uses environment default when omitted
table_nameYesTable to describe, optionally schema-qualified

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.1
    • addedInput schema / properties / jdbc_url
      Added value: +{
      +  "description": "Optional JDBC URL to target a specific database (credentials embedded in URL); uses environment default when omitted",
      +  "type": "string"
      +}
  2. First observedv1.0.1

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered elsewhere. The description adds only the returned field set, and says nothing about behavior on a missing table, permission requirements, or how the JDBC connection is resolved beyond what the schema already states.

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?

A single front-loaded sentence with no filler. Every word (columns, types, keys, defaults) carries information about the result.

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 simple two-parameter read tool with full annotation and schema coverage and no output schema, the description covers purpose and result shape adequately. The only shortfall is the absence of any routing hint toward related schema-inspection tools.

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?

Schema description coverage is 100%, so both jdbc_url and table_name are already documented, including the environment-default fallback and the schema-qualified option. The description adds no meaning beyond that, which is the expected baseline when the schema does the work.

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 uses a specific verb (describe) plus resource (database table) and enumerates the shape of the result: columns, types, keys, defaults. That is far more informative than a restatement of the name. It does not, however, differentiate itself from siblings such as analyze_schema_normalization or export_schema_ddl, which an agent could plausibly confuse with it.

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 and no mention of alternatives or prerequisites. Nothing tells the agent whether to reach for this before query_database, or when to prefer export_schema_ddl for full DDL rather than a per-table description.

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