Skip to main content
Glama
ai-ready-warehouse

ai-ready-warehouse

by KNMDeep

describe_table

Retrieve columns, data types, and business descriptions for a warehouse table before writing SQL so queries use the correct fields and understand their meaning.

Instructions

Columns, types and business descriptions for one ai_ready table. Read the descriptions before writing SQL against the table.

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

Input Schema

NameRequiredDescriptionDefault
tableYesTable name, without the schema

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full disclosure burden; it implies a read-only metadata lookup but never states read-only behavior explicitly. It also omits what happens with an unknown or non-ai_ready table name and whether the result is scoped by permissions, leaving meaningful behavioral gaps for a no-annotation tool.

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 compact sentences: the first states what is returned and the second states the usage rule. Nothing is wasted and the payload description is front-loaded.

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 single-parameter read tool with no output schema, the description usefully enumerates the returned content (columns, types, business descriptions). Remaining gaps around error behavior and completeness of metadata are minor rather than blocking.

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 the single parameter is already documented as the table name without schema. The description adds a small constraint by specifying the table must be an "ai_ready" table, but provides no syntax, case sensitivity, or qualification details 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 names the specific resource (one ai_ready table's columns, types, and business descriptions), which is clearly distinct from list_tables (enumeration) and query (SQL execution). It stops short of explicitly contrasting with those siblings, so it lands at a clear-but-not-differentiating 4.

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?

"Read the descriptions before writing SQL against the table" gives a concrete precondition for calling this tool, implying it should precede query usage. It does not name query or list_tables as alternatives or state any exclusions, so it is clear context without full routing guidance.

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

Deploy Server

Other Tools