MCP Server Starrocks

🚀 星辰 rocks MCP 服务器

星辰 rocks MCP 服务器是一个用于与星辰 rocks 数据库交互的模型控制协议（MCP）服务器。它为 AI 模型提供了标准化接口，可借助一组定义工具对星辰 rocks 数据库进行查询和操作。

🚀 快速开始

星辰 rocks MCP 服务器允许 AI 模型在星辰 rocks 数据库上执行多种操作，如 SELECT 查询、列出可用表、描述表结构等，还能在非只读模式下创建新表和执行写入操作。

✨ 主要特性

• 执行星辰 rocks 数据库上的 SELECT 查询。
• 列出可用的表。
• 描述表结构。
• 创建新表（当不在只读模式时）。
• 执行写入操作，如 INSERT、UPDATE、DELETE（当不在只读模式时）。

📦 安装指南

先决条件

• Python 3.8+
• 星辰 rocks 数据库实例
• 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 检查工具

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

💻 使用示例

启动服务器

python -m mcp_server_starrocks.server --host <星辰 rocks-host> --port <星辰 rocks-port> --user <用户名> --database <数据库名称> [--password <密码>] [--readonly]

命令行参数：

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

可用工具

服务器提供了以下工具：

只读工具：

• read-query: 在星辰 rocks 数据库上执行 SELECT 查询
• list-tables: 列出星辰 rocks 数据库中的所有表
• describe-table: 描述特定表的结构

写入工具（不在只读模式时可用）：

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

基础用法

列出表格

{
    "名称": "list-tables",
    "参数": {}
}

执行 SELECT 查询

{
    "名称": "read-query",
    "参数": {
        "查询": "SELECT FROM my_table LIMIT 10"
    }
}

描述表

{
    "名称": "describe-table",
    "参数": {
        "表名": "my_table"
    }
}

高级用法

创建表（当不在只读模式时）

{
    "名称": "create-table",
    "参数": {
        "查询": "CREATE TABLE new_table (id INT, name VARCHAR(100))"
    }
}

📄 许可证

本项目采用 MIT 许可证。

🤝 贡献

欢迎贡献！请随意提交 Pull Request。