Skip to main content
Glama
startreedata

StarTree MCP Server for Apache Pinot

Official
by startreedata

tableconfig-schema-details

Retrieve table configuration and schema details for Apache Pinot by specifying the table name, enabling precise management and optimization within the StarTree MCP Server environment.

Instructions

Get table config and schema

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tableNameYes

Implementation Reference

  • The main handler function for the 'tableconfig-schema-details' tool. It is decorated with @mcp.tool, which registers it and infers the schema from the type annotations (tableName: str). Calls the helper method on pinot_client and returns JSON.
    def tableconfig_schema_details(tableName: str) -> str:
        """Get table config and schema"""
        try:
            results = pinot_client.get_tableconfig_schema_detail(tableName=tableName)
            return json.dumps(results, indent=2)
        except Exception as e:
            return f"Error: {str(e)}"
  • Supporting method in PinotClient that fetches the table configuration from the Pinot controller API endpoint. This is called by the tool handler to retrieve the data.
    def get_tableconfig_schema_detail(
        self,
        tableName: str,
        params: dict[str, Any] | None = None,
    ) -> dict[str, Any]:
        endpoint = PinotEndpoints.TABLE_CONFIG.format(tableName)
        url = f"{self.config.controller_url}/{endpoint}"
        logger.debug(f"Fetching table config for {tableName} from: {url}")
        response = self.http_request(url)
        return response.json()
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 only states the action ('Get') without explaining what 'Get' entails—such as whether it's a read-only operation, if it requires permissions, what format the output is in, or any rate limits. This leaves significant gaps in understanding the tool's behavior.

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?

The description is extremely concise with just three words, making it front-loaded and efficient. However, this brevity borders on under-specification, as it lacks necessary details for a tool with behavioral and parameter gaps, slightly reducing its effectiveness.

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), lack of annotations, 0% schema coverage, and no output schema, the description is incomplete. It doesn't address behavioral traits, parameter meaning, or output details, making it inadequate for the agent to use the tool correctly without additional context.

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

Parameters2/5

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

Schema description coverage is 0%, meaning the input schema provides no descriptions for the 'tableName' parameter. The description adds no semantic information about this parameter, such as what constitutes a valid table name, examples, or constraints. With one undocumented parameter, the description fails to compensate for the schema's lack of detail.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Get table config and schema' clearly states the verb 'Get' and the resources 'table config and schema', providing a basic understanding of what the tool does. However, it doesn't differentiate this tool from its siblings 'get-schema' and 'get-table-config', which appear to perform similar functions, making the purpose somewhat vague in 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 like 'get-schema' or 'get-table-config'. It lacks any context about prerequisites, exclusions, or comparisons with sibling tools, leaving the agent with no usage direction beyond the basic purpose.

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

Related 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/startreedata/mcp-pinot'

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