Skip to main content
Glama
dataparity

dataparity

dataparity_describe_table

Return column names, data types, and nullability for a table to select key and comparison columns before parity checks.

Instructions

Return detailed metadata for one table, including each column name, type, and nullability. Use this after dataparity_list_tables to choose key and comparison columns.

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": {
      "source": "<source>",
      "table": "<table>"
    },
    "name": "dataparity_describe_table"
  }
}

Input Schema

NameRequiredDescriptionDefault
tableYesThe table name, optionally schema-qualified.
sourceYesThe configured source name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations supplied, the description carries the full burden; it implies a safe read by saying 'Return detailed metadata', which is helpful. However, it says nothing about permissions, what happens for an unknown table or source, or whether the output is large enough to be truncated — meaningful gaps for a tool with zero annotation coverage.

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 sentences, zero filler, with the capability stated first and the usage cue second. Nothing could be removed without losing information.

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

Completeness4/5

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

For a simple two-parameter read tool with no output schema, the description covers both what goes in and roughly what comes back (per-column name, type, nullability), which is the key missing piece when no output schema exists. It leaves the return container shape (single object vs. list) and error behavior unstated, a minor gap.

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 coverage is 100% and both parameters are documented there, including the schema-qualified note for 'table', so the schema does the heavy lifting. The description adds only the downstream intent of the parameters (picking key and comparison columns), not format or validation detail beyond the schema.

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

Purpose4/5

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

The description gives a specific verb and resource ('Return detailed metadata for one table') and enumerates the returned fields (column name, type, nullability), which is far more than a restatement of the name. It stops short of explicitly distinguishing itself from dataparity_diff_tables, which also operates on tables.

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?

'Use this after dataparity_list_tables to choose key and comparison columns' gives a clear sequencing dependency and a concrete purpose, a strong when-to-use signal. It does not state when not to use it (e.g., versus diff_tables) or any preconditions such as requiring a configured source to exist first.

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