Skip to main content
Glama

Get Table Schema

getTableSchema
Read-onlyIdempotent

Retrieve column definitions and foreign key relationships for any table. Use this before writing queries to understand column names, data types, nullable status, and constraints.

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.
Behavior5/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds behavioral context: it returns column definitions, nullability, primary keys, defaults, and foreign keys. No contradictions.

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?

The description is well-structured with separate sections for use case, examples, and return info. It is front-loaded with the essential purpose and adds detail without verbosity. Every part serves a clear 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?

The tool is simple with one parameter and has an output schema. The description explains what it returns and provides complete context for usage. Nothing is missing given the tool's complexity and available structured metadata.

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% with a single parameter 'table' that has a clear description. The description reinforces this and adds usage context ('call listTables first'), providing value beyond the schema alone.

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 'Get column definitions and foreign key relationships for a table', with a specific verb and resource. It distinguishes itself from sibling tools (listTables, explainQuery, etc.) by focusing on schema introspection.

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?

Explicitly says 'ALWAYS call this before writing queries' and provides examples of when to use. Also mentions prerequisite 'call listTables first'. Lacks explicit when-not-to-use or alternative tools, but the context makes usage very clear.

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