StarRocks MCP server

The StarRocks MCP Server provides a standardized interface that allows AI models to interact with StarRocks databases. It enables models to execute queries, manage tables, and perform various database operations through a set of predefined tools.

Installation

Prerequisites

• Python 3.8+
• StarRocks database instance
• SQLAlchemy
• MCP Python library

Install from Source

git clone https://github.com/yourusername/mcp-server-starrocks.git
cd mcp-server-starrocks
pip install -e .

Install from Smithery

npm install @smithery/sdk @modelcontextprotocol/sdk

Using MCP Inspector

npx @modelcontextprotocol/inspector uv --directory ~/mcp-server-starrocks run mcp-server-starrocks

Usage

Starting the Server

Launch the MCP server with appropriate connection parameters:

python -m mcp_server_starrocks.server --host <starrocks-host> --port <starrocks-port> --user <username> --database <database-name> [--password <password>] [--readonly]

Command-line Arguments

• --host: StarRocks server host (required)
• --port: StarRocks server port (default: 9030)
• --user: StarRocks username (required)
• --database: StarRocks database name (required)
• --password: StarRocks password (if required)
• --readonly: Run the server in read-only mode (optional)

Available Tools

Read-only Tools

The server provides these tools for data retrieval and exploration:

• read-query: Execute a SELECT query on the StarRocks database
• list-tables: List all tables in the StarRocks database
• describe-table: Describe the schema of a specific table

Write Tools

These tools are available when not running in read-only mode:

• write-query: Execute an INSERT, UPDATE, or DELETE query
• create-table: Create a new table in the StarRocks database

Example Usage

Listing Tables

{
    "name": "list-tables",
    "arguments": {}
}

Executing a SELECT Query

{
    "name": "read-query",
    "arguments": {
        "query": "SELECT FROM my_table LIMIT 10"
    }
}

Describing a Table

{
    "name": "describe-table",
    "arguments": {
        "table_name": "my_table"
    }
}

Creating a Table

Only available when not in read-only mode:

{
    "name": "create-table",
    "arguments": {
        "query": "CREATE TABLE new_table (id INT, name VARCHAR(100))"
    }
}

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "mcp-server-starrocks" '{"command":"python","args":["-m","mcp_server_starrocks.server"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "mcp-server-starrocks": {
            "command": "python",
            "args": [
                "-m",
                "mcp_server_starrocks.server"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "mcp-server-starrocks": {
            "command": "python",
            "args": [
                "-m",
                "mcp_server_starrocks.server"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect