MCP Server Starrocks

🚀 StarRocks MCP Server

A Model Control Protocol (MCP) server for interacting with the StarRocks database. This server provides a standardized interface for AI models to query and manipulate the StarRocks database through a set of defined tools.

🚀 Quick Start

The StarRocks MCP server enables AI models to perform various operations on the StarRocks database, offering a standardized way to interact with the data.

✨ Features

• Execute SELECT queries on the StarRocks database.
• List available tables.
• Describe table structures.
• Create new tables (when not in read - only mode).
• Perform write operations such as INSERT, UPDATE, and DELETE (when not in read - only mode).

📦 Installation

Prerequisites

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

Install from Source Code

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

Install via Smithery

npm install @smithery/sdk @modelcontextprotocol/sdk

Use the MCP Inspector Tool

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

💻 Usage Examples

Start the Server

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

The server offers the following tools:

Read - only Tools:

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

Write Tools (available when not in read - only mode):

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

Basic Usage

List Tables

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

Execute a SELECT Query

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

Advanced Usage

Describe a Table

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

Create a Table (when not in read - only mode)

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

📄 License

MIT License

🔗 Contribution

Contributions are welcome! Feel free to submit a Pull Request.