describe_table
Get table details including columns, constraints, indexes, and optional row count. Specify schema or output format for customized results.
Instructions
Get detailed information about a table including columns, constraints, and indexes.
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": "<table>"
},
"name": "describe_table"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | Name of the table or view to describe | |
| format | No | Output format (default: markdown) | markdown |
| schema | No | Schema name (defaults to current user's schema) | |
| connection | Yes | Name of the database connection to use | |
| include_row_count | No | Whether to get the row count (can be slow for large tables) |