Skip to main content
Glama
gxc

gaussdb-ro-mcp

by gxc

list_tables

List GaussDB tables and views with name, type, estimated rows, and comments, optionally filtered by schema, to locate target tables before inspecting structure or sampling data.

Instructions

列出 GaussDB 数据库中的表和视图清单:名称、类型(表/视图/物化视图/分区表/外表)、估算行数与注释。schema 参数可过滤到指定模式(可来自 list_schemas 的结果),省略时扫描全部非系统模式。适用场景:定位目标表后,用 describe_table 查看结构或用 execute_select 抽样查询。大型库建议传 schema 缩小扫描范围。

Input Schema

NameRequiredDescriptionDefault
schemaNo限定模式名(schema),省略时扫描全部非系统模式
instanceNo数据源名称,省略时使用默认实例。可选实例:demo(默认)
include_systemNo是否包含系统模式,默认 false

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.3.0
    • changedInput schema / properties / instance / description
      Previous value: -"数据源名称(配置文件中 instance 的 name),省略时使用默认实例"New value: +"数据源名称,省略时使用默认实例。可选实例:demo(默认)"
  2. First observedv0.2.2

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the exact result fields, the default scan scope (all non-system schemas when schema is omitted), and a performance caveat for large databases. It stops short of stating permission/auth requirements or ordering/pagination, but covers what an agent needs to invoke it safely.

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?

Front-loaded with the resource and return fields, then usage and the filtering tip. Every sentence carries information, though the final sentence partially restates the schema-omission behavior already stated earlier.

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?

No output schema exists, so the description must explain returns, which it does by listing the returned columns. Combined with usage routing and the filtering/performance caveat, nothing an agent needs to call this correctly is missing.

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

Parameters4/5

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

Schema coverage is already 100%, so the baseline is 3, but the description adds real value beyond the schema by explaining where the schema value comes from (list_schemas output) and why to supply it (narrow scan range). Remaining parameters are only reinforced, not extended, so it lands at 4.

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+resource (list tables/views in GaussDB) and enumerates exactly what the result contains (name, type, estimated row count, comment). It clearly distinguishes itself from siblings by naming describe_table, execute_select and list_schemas by their distinct roles.

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

Usage Guidelines5/5

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

Gives explicit when-to-use guidance: locate a table here, then use describe_table for structure or execute_select for sampling. It also names the alternative source of the schema value (list_schemas) and the large-database condition that favors passing schema.

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