Skip to main content
Glama
truaxki
by truaxki

describe_table

Display the structure of a database table to understand its columns, data types, and schema details for data analysis or troubleshooting.

Instructions

Show structure of a specific table

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
table_nameYesName of the table to describe

Implementation Reference

  • Handler implementation for the 'describe_table' tool. It extracts the table_name from arguments, queries sqlite_master for the table's CREATE SQL statement, and returns the result as text content.
    elif name == "describe_table":
        if not arguments or "table_name" not in arguments:
            raise ValueError("Missing table_name argument")
        table_name = arguments["table_name"]
        # Get table creation SQL instead of using PRAGMA
        results = db._execute_query(
            f"SELECT sql FROM sqlite_master WHERE type='table' AND name=?", 
            (table_name,)
        )
        return [types.TextContent(type="text", text=str(results))]
  • JSON schema defining the input for 'describe_table' tool: requires a 'table_name' string parameter.
    inputSchema={
        "type": "object",
        "properties": {
            "table_name": {
                "type": "string",
                "description": "Name of the table to describe"
            }
        },
        "required": ["table_name"]
    }
  • Registration of the 'describe_table' tool in the @server.list_tools() handler, specifying name, description, and input schema.
    types.Tool(
        name="describe_table",
        description="Show structure of a specific table",
        inputSchema={
            "type": "object",
            "properties": {
                "table_name": {
                    "type": "string",
                    "description": "Name of the table to describe"
                }
            },
            "required": ["table_name"]
        }
    ),
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'show structure' but does not specify what 'structure' entails (e.g., column names, types, constraints), whether it requires permissions, or if it's read-only (implied but not explicit). This leaves gaps in understanding the tool's behavior and limitations.

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 a single, clear sentence: 'Show structure of a specific table'. It is front-loaded with the core purpose, has no redundant words, and efficiently communicates the essential action without unnecessary elaboration, making it highly concise and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (a read operation with one parameter) and lack of annotations or output schema, the description is incomplete. It does not explain what 'structure' includes (e.g., schema details), potential errors (e.g., if table doesn't exist), or return format, leaving the agent with insufficient context for reliable use.

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?

The input schema has 100% coverage, with 'table_name' fully described as 'Name of the table to describe'. The description adds no additional parameter semantics beyond this, such as format examples or constraints. With high schema coverage, the baseline score of 3 is appropriate, as the schema handles the parameter documentation adequately.

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 'Show structure of a specific table' clearly states the verb 'show' and resource 'structure of a specific table', making the purpose evident. However, it does not explicitly differentiate from siblings like 'list_tables' (which likely lists table names) or 'read_query' (which might query table data), leaving room for ambiguity in sibling context.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention prerequisites (e.g., table must exist), exclusions (e.g., not for querying data), or refer to sibling tools like 'list_tables' for discovery or 'read_query' for data retrieval, offering minimal usage context.

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/truaxki/mcp-variance-log'

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