Explore the schema · stop 4 of 10

describe_object

Shows one table or view in full: columns, types, keys and indexes.

Works in read modeTool sets: query · meta · full

You might ask

“What columns does the orders table have?”

Your assistant may call describe_object to answer.

How it works

Takes schema.name; a bare name works when only one schema has it.
With resolve_refs, it adds enum values and a sample of the labels behind foreign-key IDs, so the assistant knows that status_id = 3 means "shipped".

tablestringrequired: Table, view, or materialized view as "schema.name" (e.g. "public.customers"); a bare name is resolved if unambiguous.
connectionIdstring: Optional connection profile override — does not change session context.
databasestring: Database to use instead of the current one, on connectionId or the active connection.
resolve_refsboolean: When true, attach enum values and resolved FK label samples on columns.
resolve_refs_limitnumber: Max distinct FK values to resolve per column when resolve_refs is true. Default 20.

The description nexql-mcp sends with the tool. It's how the assistant decides when to use it.

Get structural details of a specific database object (table, view, or materialized view) including columns, data types, constraints, and indexes.