Skip to main content
Glama
doris-mcp

doris-mcp

by fhm0520

doris_get_cluster_overview

Read-onlyIdempotent

Get a cluster overview of FE/BE nodes, database/table statistics, and capacity; falls back to BE-only if FE queries time out.

Instructions

集群概览:FE 节点(SHOW FRONTENDS)、BE 节点(information_schema.backends)、 库表统计(SHOW PROC '/statistic')、库容量(SHOW PROC '/dbs')。 FE 查询给短超时,取不到就降级为只给 BE,不阻塞整体返回。

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "doris_get_cluster_overview"
  }
}

Input Schema

NameRequiredDescriptionDefault
include_nodesNo是否包含 FE / BE 节点明细

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so the safety profile is covered. The description still adds real behavioral value beyond that: it discloses that the FE query runs under a short timeout and that failure causes a graceful downgrade to BE-only data rather than an error, so the agent knows the response may be partial. It does not state what other failures look like, which keeps it from a 5.

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 tight and front-loaded, listing the four data sources first and the degradation behavior second. Every clause carries information, with no filler or repetition of the title.

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?

An output schema exists, so return-value structure need not be explained. For a moderately complex aggregation tool, the description covers what is collected and the key failure mode (partial results under FE timeout), leaving only minor gaps around how errors other than FE timeout are surfaced.

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 single parameter include_nodes already carries its own description ('是否包含 FE / BE 节点明细'). The prose adds no further semantics such as default interactions or what happens to the node sections when it is false. Baseline 3 applies when the schema does the work.

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 names a specific resource (cluster overview) and enumerates exactly what it aggregates: FE nodes via SHOW FRONTENDS, BE nodes via information_schema.backends, table statistics via SHOW PROC '/statistic', and database capacity via SHOW PROC '/dbs'. This makes the scope concrete and clearly broader than the narrower sibling tools like doris_get_table_size or doris_ping, though it never explicitly says how it differs from them.

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

Usage Guidelines3/5

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

Usage is implied by the name and the aggregation scope: this is the broad first-look tool for a cluster. There is no explicit statement of when to choose it over doris_get_compaction_status, doris_get_ingestion_status, or doris_ping, and no stated preconditions or exclusions.

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