Skip to main content
Glama

Get Table Schema

getTableSchema
Read-onlyIdempotent

Retrieves column definitions and foreign key relationships for a specified table. Use to understand column names, data types, nullable, primary keys, defaults, and foreign keys before writing queries.

Instructions

Get column definitions and foreign key relationships for a table. Requires table — call listTables first.

<what_it_returns> A JSON object with table and columns keyed by column name, each containing type, nullable, key, default, and foreignKey info. </what_it_returns>

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tableYesThe table name to inspect. Use `listTables` first to see available tables.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
columnsYesColumn definitions keyed by column name.
tableYesName of the inspected table.
Behavior4/5

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

Annotations already declare read-only, non-destructive, idempotent. Description adds behavior: returns column definitions and foreign keys, and outlines return structure. No contradiction with annotations.

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?

Description is well-structured with <usecase>, <examples>, <what_it_returns>. Each section adds value; no wasted words. Front-loaded with purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given output schema exists, description adequately covers prerequisites, use cases, and return structure. Complete for a simple tool with strong annotations.

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 coverage is 100% and description of parameter in schema already says to use listTables first. Description adds no additional meaning beyond schema.

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?

Description clearly states 'Get column definitions and foreign key relationships for a table.' This distinguishes from sibling tools like listTables (lists tables) and readQuery (executes queries).

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

Usage Guidelines5/5

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

Explicitly requires table parameter and instructs to call listTables first. <usecase> and <examples> clearly indicate when to use (before writing queries).

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

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/haymon-ai/dbmcp'

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