describe_table
Describe a cached table with its columns, defaults, comments, and foreign-key relationships. Use to obtain keys needed for writing SQL joins.
Instructions
Describe one cached table in detail, including its foreign-key relationships.
Returns columns (with defaults/comments), outgoing foreign keys, and incoming references from other tables. Use when you need a single table's keys to write a join; for a list of all tables use list_tables. Reads the cache (introspect first). Raises if the table is not found.
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": {
"connection": "<connection>",
"table_name": "<table_name>"
},
"name": "describe_table"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| connection | Yes | Target database connection — its name or id (case-insensitive). List the available connections with list_connections. | |
| table_name | Yes | Exact table name to describe, as shown by list_tables. |