Skip to main content
Glama

describe_table

Retrieve comprehensive schema details, column definitions, and metadata for a specified table in CockroachDB, enabling precise query formulation and data manipulation.

Instructions

Provide detailed schema information, column definitions, data types, and other metadata for a specified table. This allows the AI to accurately interpret table structures and formulate precise queries or data manipulation commands.

Args: table_name (str): Name of the table. db_schema (str): Schema name (default: "public").

Returns: Table details including columns, constraints, indexes, and metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
db_schemaNopublic
table_nameYes
Behavior2/5

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

No annotations are provided, so the description carries full burden. It describes the tool's function but lacks behavioral details such as whether it's read-only, potential error conditions (e.g., if table doesn't exist), authentication needs, or rate limits. The description doesn't contradict annotations, but it's insufficient for a mutation-free tool with zero annotation coverage.

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?

The description is appropriately sized and front-loaded, starting with the core purpose. The Args and Returns sections are structured but slightly verbose; every sentence earns its place by adding value, though it could be more concise by integrating the explanatory sentence into the main description.

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?

Given 2 parameters with 0% schema coverage and no output schema, the description provides basic parameter semantics and return value overview but lacks details on output structure, error handling, or behavioral traits. It's minimally adequate for a read-only metadata tool but has clear gaps in completeness.

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 description coverage is 0%, so the description must compensate. It adds meaning by explaining table_name ('Name of the table') and db_schema ('Schema name (default: "public")'), which clarifies parameter roles beyond the schema's basic titles. However, it doesn't detail format constraints or examples for these parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('provide detailed schema information') and resources ('for a specified table'), distinguishing it from siblings like list_tables (which lists tables) or get_table_relationships (which focuses on relationships). It explicitly mentions what metadata is provided (column definitions, data types, constraints, indexes).

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

Usage Guidelines3/5

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

The description implies usage context ('allows the AI to accurately interpret table structures and formulate precise queries'), suggesting when this tool is useful, but doesn't explicitly state when to use it versus alternatives like analyze_schema or get_table_relationships. No explicit exclusions or prerequisites are provided.

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

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/amineelkouhen/mcp-cockroachdb'

If you have feedback or need assistance with the MCP directory API, please join our Discord server