describe_table
Inspect a table or view to reveal its columns, types, indexes, foreign keys and constraints. Use it to understand schema structure before writing queries or migrations.
Instructions
Describes a table or view: columns (type, nullable, default, primary key, comment, enum values), indexes, foreign keys, other constraints and the foreign keys of other tables that point at it. Also the notes, tags and sensitive marks the user set in PlatypusDB (note, tags, sensitive: true or false, never values), when there are any.
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>",
"schema": "<schema>",
"table": "<table>"
},
"name": "describe_table"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| table | Yes | The table or view. | |
| schema | Yes | The table's schema. | |
| connection | Yes | The connection's name, as `list_connections` shows it. |