Skip to main content
Glama
doris-mcp

doris-mcp

by fhm0520

doris_describe_table

Read-onlyIdempotent

Retrieve a Doris table’s column definitions—names, types, nullability, keys, defaults, extras, and comments—plus optional DDL, table statistics, and index details.

Instructions

查看表结构:字段名、类型、是否可空、是否 key 列、默认值、Extra(聚合类型等)、注释。 注释取自 SHOW FULL COLUMNS —— 1.2 上最完整的列元数据来源。 include_basic 用 SHOW TABLE STATUS 补引擎/行数/创建时间(官方 get_table_context 的 basic 段)。

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": "doris_describe_table"
  }
}

Input Schema

NameRequiredDescriptionDefault
tableYes表名
databaseYes数据库名
include_ddlNo是否返回 SHOW CREATE TABLE 的 DDL
include_basicNo是否返回引擎/行数/创建时间/表注释
include_indexesNo是否返回索引信息

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the safety profile is covered. Beyond that, the description discloses data provenance — SHOW FULL COLUMNS for columns and SHOW TABLE STATUS for the basic section — which tells the agent how fresh/authoritative each returned field is. It does not discuss latency or cost of the optional flags, so a 4.

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

Conciseness4/5

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

Three short lines with the primary output list front-loaded, then provenance notes for the column and basic paths. No filler, though the trailing parenthetical about the official get_table_context section is of narrow value to an agent choosing a tool.

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?

An output schema exists, so return formatting need not be explained, and all five parameters are documented in the schema with the description adding source context for the two main paths. What is missing is any routing guidance relative to the other table-inspection siblings, which for a read-only describe tool is 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 every parameter has a Chinese description in the schema, including include_basic covering 引擎/行数/创建时间/表注释. The description adds only marginal meaning beyond that: the underlying statement for include_basic and a reference to the official get_table_context basic section. include_ddl and include_indexes get no elaboration in the description. 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 first line states a specific verb+resource (查看表结构) and enumerates exactly what is returned: column name, type, nullability, key flag, default, Extra/aggregation type, comment. That is far more precise than the name alone and separates it from siblings like doris_list_tables or doris_get_table_size. It stops short of naming those siblings explicitly, so it lands at 4 rather than 5.

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

Usage Guidelines3/5

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

Usage is implied — reach for this when you need column-level metadata for one table — and the note that SHOW FULL COLUMNS is 最完整的列元数据来源 hints this is the preferred source for column detail. There is no explicit when/when-not, no mention of doris_get_table_partitions or doris_get_table_size as alternatives, and no prerequisite guidance.

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