Skip to main content
Glama
dockndevai

mcp-clickhouse

Describe table

describe_table
Read-onlyIdempotent

Retrieve column names, types, defaults, and comments for any ClickHouse table. Provide database and table names to get the full schema details needed for analysis and management.

Instructions

Column names, types, defaults, and comments for a table.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tableYesTable name
databaseYesDatabase name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare this as read-only, idempotent, and non-destructive, so the description's job is light. It adds some context about the returned metadata fields but does not describe behavior like errors, sorting, or format. No contradiction with annotations.

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?

A single, compact sentence with no filler or redundant information. It front-loads the core purpose and is easy to parse.

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-only tool with strong annotations, the description adequately conveys the output in lieu of an output schema. It falls slightly short because it does not clarify how this differs from show_create_table, leaving potential ambiguity.

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% — both database and table have clear descriptions. The tool description does not add meaning beyond the schema, so the baseline 3 applies.

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 states the specific output content — column names, types, defaults, and comments — for a table, which clearly distinguishes it from siblings like list_tables and table_stats. It lacks an explicit verb but the intent is obvious and not a tautology.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus alternatives like show_create_table or table_stats. The agent must infer usage solely from the resource name and description.

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