StarRocks MCP Server

StarRocks MCP Server

用于与 StarRocks 数据库交互的 Model Control Protocol（MCP）服务。该服务提供标准化接口，让 AI 模型通过一组定义好的工具查询和操作 StarRocks 数据库。

概述

StarRocks MCP Server 支持 AI 模型：

• 在 StarRocks 数据库上执行 SELECT 查询
• 列出可用表
• 查看表结构
• 创建新表（在非只读模式下）
• 执行 INSERT、UPDATE、DELETE 等写入操作（在非只读模式下）

安装

前置条件

• Python 3.8+
• StarRocks 数据库实例
• SQLAlchemy
• MCP Python 库

从源代码安装

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

从 Smithery 安装

npm install @smithery/sdk @modelcontextprotocol/sdk

使用 MCP Inspector

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

使用方法

启动服务

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

命令行参数：

• --host：StarRocks 服务主机（必填）
• --port：StarRocks 服务端口（默认：9030）
• --user：StarRocks 用户名（必填）
• --database：StarRocks 数据库名称（必填）
• --password：StarRocks 密码（如需要）
• --readonly：以只读模式运行服务（可选）

可用工具

该服务提供以下工具：

只读工具：

• read-query：在 StarRocks 数据库上执行 SELECT 查询
• list-tables：列出 StarRocks 数据库中的所有表
• describe-table：查看特定表的结构

写入工具（在非只读模式下可用）：

• write-query：执行 INSERT、UPDATE 或 DELETE 查询
• create-table：在 StarRocks 数据库中创建新表

示例

列出表

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

执行 SELECT 查询

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

查看表

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

创建表（在非只读模式下）

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

许可证

MIT 许可证

贡献

欢迎贡献！欢迎提交 Pull Request。