inspect

Replaces (v1)

This tool unifies: describe_table, get_indexes and get_foreign_keys from the previous version.

Unified tool for inspecting a table’s structure. Replaces describe_table, get_indexes and get_foreign_keys.

Parameters

Parameter	Type	Description
table_name	string	Required. Table name. Accepts dbo.Table or just Table
schema	string	Schema name (default: dbo)
detail	string	What to retrieve: columns (default), indexes, foreign_keys, all

Usage modes

Columns (default)

{ "name": "inspect", "arguments": { "table_name": "Orders" } }

Indexes

{ "name": "inspect", "arguments": { "table_name": "Orders", "detail": "indexes" } }

Foreign keys

{ "name": "inspect", "arguments": { "table_name": "Orders", "detail": "foreign_keys" } }

Everything in one call

{ "name": "inspect", "arguments": { "table_name": "Orders", "detail": "all" } }

With detail=all the result groups sections under the keys columns, indexes and foreign_keys.

Example response (detail=all)

{
  "columns": [ {"column_name": "Id", "data_type": "int", ...} ],
  "indexes": [ {"index_name": "PK_Orders", "is_primary_key": true, ...} ],
  "foreign_keys": [ {"constraint_name": "FK_Orders_Customers", ...} ]
}