MCP 服务器

StarRocks MCP Server

A TypeScript implementation of a Model Context Protocol server that enables interaction with StarRocks databases, supporting SQL operations like queries, table creation, and data manipulation through standardized MCP tools.

README

StarRocks MCP Server

一个专业的 TypeScript 版本的 StarRocks MCP (Model Context Protocol) 服务器实现。

功能特性

🔌 完整的 MCP 协议支持 - 实现了标准的 MCP 协议
🗄️ StarRocks 数据库集成 - 支持 StarRocks 数据库的所有操作
🛠️ 多种 SQL 操作 - 支持 SELECT、INSERT、UPDATE、DELETE、CREATE TABLE 等
🔒 安全性 - 内置 SQL 验证和错误处理
📝 完整的日志系统 - 支持不同级别的日志记录
🧪 测试覆盖 - 包含完整的单元测试
📦 TypeScript 支持 - 完整的类型定义和类型安全

支持的 MCP 工具

工具名称	描述	参数
`run_sql_query`	执行只读 SQL 查询（仅限 SELECT 语句）	`query: string`
`create_table`	在 StarRocks 数据库中创建新表	`query: string`
`insert_data`	向 StarRocks 数据库表插入数据	`query: string`
`update_data`	更新 StarRocks 数据库表中的数据	`query: string`
`delete_data`	从 StarRocks 数据库表中删除数据	`query: string`
`execute_sql`	执行任意非 SELECT 的 SQL 语句	`query: string`

安装和设置

1. 克隆项目

git clone https://github.com/your-username/StarRocks-MCP.git
cd StarRocks-MCP

2. 安装依赖

npm install

3. 配置环境变量

复制环境变量示例文件：

cp env.example .env

编辑 .env 文件，配置你的 StarRocks 数据库连接信息：

# StarRocks Database Configuration
STARROCKS_HOST=localhost
STARROCKS_PORT=9030
STARROCKS_USER=root
STARROCKS_PASSWORD=your_password_here
STARROCKS_DATABASE=your_database_name

# Optional Configuration
STARROCKS_CHARSET=utf8mb4
STARROCKS_TIMEZONE=local
STARROCKS_CONNECTION_LIMIT=10
STARROCKS_ACQUIRE_TIMEOUT=60000
STARROCKS_TIMEOUT=60000

# Logging Configuration
NODE_ENV=production
LOG_LEVEL=info

4. 构建项目

npm run build

5. 运行服务器

npm start

开发

开发模式运行

npm run dev

运行测试

npm test

代码检查

npm run lint

代码格式化

npm run format

项目结构

src/
├── connection/          # 数据库连接管理
│   └── StarRocksConnection.ts
├── server/             # MCP 服务器核心
│   └── StarRocksMCPServer.ts
├── types/              # TypeScript 类型定义
│   └── index.ts
├── utils/              # 工具类
│   ├── ErrorHandler.ts
│   ├── Logger.ts
│   └── SqlValidator.ts
├── tests/              # 测试文件
│   ├── setup.ts
│   └── StarRocksConnection.test.ts
└── index.ts            # 主入口文件

使用示例

1. 查询数据

{
  "method": "tools/call",
  "params": {
    "name": "run_sql_query",
    "arguments": {
      "query": "SELECT * FROM users WHERE age > 18;"
    }
  }
}

2. 创建表

{
  "method": "tools/call",
  "params": {
    "name": "create_table",
    "arguments": {
      "query": "CREATE TABLE users (id INT PRIMARY KEY, name VARCHAR(100), age INT);"
    }
  }
}

3. 插入数据

{
  "method": "tools/call",
  "params": {
    "name": "insert_data",
    "arguments": {
      "query": "INSERT INTO users (id, name, age) VALUES (1, 'John', 25);"
    }
  }
}

配置选项

数据库配置

配置项	默认值	描述
`STARROCKS_HOST`	`localhost`	StarRocks 服务器主机
`STARROCKS_PORT`	`9030`	StarRocks 服务器端口
`STARROCKS_USER`	`root`	数据库用户名
`STARROCKS_PASSWORD`	`''`	数据库密码
`STARROCKS_DATABASE`	`undefined`	默认数据库名
`STARROCKS_CHARSET`	`utf8mb4`	字符集
`STARROCKS_TIMEZONE`	`local`	时区

连接配置

配置项	默认值	描述
`STARROCKS_CONNECTION_LIMIT`	`10`	连接池大小
`STARROCKS_ACQUIRE_TIMEOUT`	`60000`	获取连接超时时间（毫秒）
`STARROCKS_TIMEOUT`	`60000`	查询超时时间（毫秒）