Skip to main content
Glama

NYSgpt Data Library

Describe a table

describe_table
Read-only

Return the fields (name, type, description), the table description and the row count of one table. Always call this before writing SQL: many source columns are stored as text and need try_cast.

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": {
      "database": "<database>",
      "table": "<table>"
    },
    "name": "describe_table"
  }
}

Input Schema

NameRequiredDescriptionDefault
tableYesTable name from list_tables, for example openalex_works.
databaseYesDatabase name, for example govblock_scholarly.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description still adds real value by disclosing the return payload (since there is no output schema) and the non-obvious stored-as-text column gotcha requiring try_cast. It does not cover failure behavior such as an unknown table or database name.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences, zero waste: the first defines the return value, the second delivers the mandatory call ordering and its rationale. Nothing is buried or repeated.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple, read-only, two-parameter metadata tool with no output schema, the description fully carries its weight: it describes the returned fields, the scope, and the critical downstream implication (try_cast for text-typed columns). Nothing an agent needs in order to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and both parameters are documented there, including an example table name and database name. The description adds no parameter-level meaning beyond 'one table', so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Return the fields... of one table') and enumerates exactly what comes back: field names, types, descriptions, the table description and row count. The 'one table' scoping also separates it in spirit from list_tables/list_databases, which operate on collections.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit, imperative usage rule — 'Always call this before writing SQL' — plus the reason (text columns needing try_cast), which tells the agent when this tool is mandatory. It stops short of naming alternatives such as query or list_tables for discovery, so it does not reach the full when-to-use/when-not/alternative bar.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.