Get Database Schema Overview
get_schema_overviewRetrieve a Markdown summary of database schema including tables, columns, data types, primary and foreign keys, constraints, and defaults, with optional filtering by schema or table.
Instructions
Markdown overview of database schema: tables, columns, types, PKs, FKs, unique/check constraints, defaults. Use get_plantuml_diagram for visual ER output or describe_table for single-table detail.
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": {
"serverName": "<serverName>",
"databaseName": "<databaseName>"
},
"name": "get_schema_overview"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| compact | No | true/false. Show only PK/FK columns without data types | |
| maxTables | No | Max tables to include (1-200, default 50) | |
| serverName | Yes | Server name from list_servers | |
| databaseName | Yes | Database name from list_databases | |
| excludeTables | No | Optional comma-separated tables to exclude. Ignored if includeTables set. | |
| includeTables | No | Optional comma-separated tables to include (e.g. 'Users,Orders'). Overrides excludeTables. | |
| excludeSchemas | No | Optional comma-separated schemas to exclude (e.g. 'audit,staging'). Ignored if includeSchemas set. | |
| includeSchemas | No | Optional comma-separated schemas to include (e.g. 'dbo,sales'). Overrides excludeSchemas. |