inspect_table
Retrieve the full structural layout of a database table, including column names, data types, nullability, primary keys, and foreign key relationships, without accessing row data.
Instructions
Exposes exact column names, types, nullability, primary keys, and foreign key relationships. Strictly constrained to structural layouts. Does not reveal data rows.
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": "inspect_table"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Output format. Use compact to reduce LLM token usage; markdown for human-readable output. | compact |
| schema | No | Optional schema/catalog namespace. Overrides DATABASE_SCHEMA only outside production. | |
| table_name | Yes | The exact case-sensitive name of the table to inspect. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |