StarRocks

Provides MCP-enabled diagnostics and SQL analysis for StarRocks databases via standardized client protocols.

javascript

GitHub Stars

javascript

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "tracymacding-starrocks-mcp-server": {
      "command": "node",
      "args": [
        "/path/to/starrocks-mcp-server/starrocks-mcp.js"
      ],
      "env": {
        "SR_HOST": "localhost",
        "SR_PORT": "9030",
        "SR_USER": "root",
        "CENTRAL_API": "http://127.0.0.1:3002",
        "PROMETHEUS_HOST": "localhost",
        "PROMETHEUS_PORT": "9092",
        "CENTRAL_API_TOKEN": "YOUR_API_TOKEN",
        "PROMETHEUS_PROTOCOL": "http"
      }
    }
  }
}

StarRocks MCP Server provides a standardized way for AI clients to diagnose and analyze StarRocks databases by implementing the Model Context Protocol (MCP). It connects to StarRocks via SQL, runs diagnostic tools, and streams results to your MCP clients in a consistent, secure way.

How to use

Use a compatible MCP client to connect to the StarRocks MCP Server. The server exposes a local, stdio-based MCP interface that you can drive from clients like Claude Code CLI or Gemini CLI. Once connected, you can access a suite of StarRocks diagnostic tools, run SQL queries against StarRocks, and receive structured analysis and recommendations. Ensure your client is configured with the proper connection details and environment variables so the server can reach StarRocks and any optional central services.

How to install

Prerequisites you need before installing:

Node.js >= 18.0.0
A StarRocks database instance reachable from the server
Optional: StarRocks Expert central service for advanced analysis
Optional: DeepSeek API Key for enhanced LLM analysis

#!/bin/bash
# Step 1: Clone the project
git clone https://github.com/tracymacding/starrocks-mcp-server.git
cd starrocks-mcp-server

# Step 2: Install dependencies
npm install

# Step 3: Start the MCP server (example)
node starrocks-mcp.js

Additional setup and notes

Configure your MCP client to connect to the StarRocks MCP Server using the provided environment details. You’ll typically set host, port, user, and optional API keys or central services in the client configuration. The server supports security-conscious environment variable configurations to protect sensitive information.

Configuration and client guidance

Two common client setup paths are shown in examples. You configure a local MCP server workflow and point your client at the local stdio MCP script. The configurations below illustrate how to wire the MCP client to the StarRocks MCP Server using standard environment variables.

Troubleshooting

If you encounter connection or runtime issues, verify the following:

Node.js version is >= 18
The starrocks-mcp.js script exists at the expected path
The StarRocks host/port, user, and password are correct
The server logs contain no fatal errors and the MCP interface is listening
The MCP client shows a Connected state after startup

Security considerations

Use environment variables to avoid hard-coding sensitive data in command lines or configuration files. Limit access to the MCP server and any central services, and rotate API keys or tokens as needed.

Built by

VeilStrat

AI signals for GTM teams