Skip to main content
Glama
sirjebbington

mcp-server-starrocks

Table Overview

table_overview

Retrieve a table's columns, up to 3 sample rows, and total row count. Use refresh=true to bypass cache for current data.

Instructions

Get an overview of a specific table: columns, sample rows (up to 3), and total row count. Uses cache unless refresh=true. Use set_session_db to set a per-session default database

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tableYesTable name, optionally prefixed with database name (e.g., 'db_name.table_name'). If database is omitted, uses the default database.
refreshNoSet to true to force refresh, ignoring cache. Defaults to false.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

A4/5.0
Behavior3/5

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

No annotations are provided, so the description must carry the full burden. It discloses caching behavior and the ability to bypass it with 'refresh=true'. However, it does not explain what happens if the table does not exist, or whether the operation is read-only, or potential rate limits. Some behavioral aspects are missing.

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 and front-loaded with the key outputs. Two sentences cover the essential behavior and a key usage tip, with no wasted words. The cache/refresh behavior is mentioned early, and the set_session_db tip is a useful addition.

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?

Given the tool's simplicityhe has an output schema so return structure is likely documented elsewhere. The description includes cache behavior and default database handling, which are key context. It could mention prerequisites like needing to set a session database or handling non-existent tables, but overall it is fairly complete for the tool's complexity.

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%, so the schema already explains both parameters in detail. The description adds minimal extra value by implying the 'refresh' flag toggles cache usage, but it doesn't provide substantial additional meaning beyond the schema.

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 clearly states the tool's purpose: getting an overview of a specific table with specific outputs (columns, sample rows, total row count). It distinguishes itself from siblings by focusing on table-level overview rather than queries or analyses, and the mention of cache and refresh is a unique trait.

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 description provides clear context on when to use the tool: when needing an overview of a table. It mentions using 'set_session_db' to set a default database, but does not explicitly state when not to use this tool or direct to alternatives. Still, the sibling list shows other tools for queries and analyses, so the usage is fairly implied.

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