Skip to main content
Glama
NekoTarou

kingbase-mcp-server

by NekoTarou

Describe Table

kb_describe_table
Read-onlyIdempotent

Retrieve the full structure of a database table or view, including columns, data types, constraints, and comments, with optional schema specification.

Instructions

Get detailed structure of a table or view, including columns, types, constraints, and comments.

Args:

  • table (string): Table or view name

  • schema (string, optional): Schema name, defaults to DB_SCHEMA env or 'public'

Returns: Table structure with column names, data types, nullable, defaults, and comments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tableYesTable or view name to describe
schemaNoSchema name (default: from DB_SCHEMA env or 'public')
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true. The description adds no further behavioral context (e.g., permissions, performance implications) beyond stating that it returns structure information, thus adding some but limited value.

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?

The description is concise with two clear sections (Args and Returns), no redundant words, and front-loaded with the main action. Every sentence contributes meaningful information.

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?

Given the simple parameter set (2 params, 1 required) and the presence of annotations indicating safety, the description provides sufficient detail about the return structure (columns, types, etc.) and default schema behavior. No output schema needed.

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%, and the description essentially repeats the schema's parameter descriptions without adding new semantics such as format constraints or examples. Baseline score of 3 is appropriate.

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?

The description uses a specific verb ('Get detailed structure') and explicitly names the resource ('table or view'), clearly distinguishing it from sibling tools like kb_list_tables, kb_list_indexes, and kb_list_constraints, which serve different purposes.

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?

The purpose of obtaining table structure is clear, but the description does not provide explicit guidance on when to use this tool over alternatives such as kb_table_stats or kb_explain. However, the sibling tool names and the context of schema exploration imply appropriate usage.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/NekoTarou/kingbase-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server