Starrocks Official MCP server

Starrocks Official MCP server

site icon
2025.03.11 14
Python数据库管理数据探索系统监控数据库
StarRocks MCP Server 是一个连接AI助手和StarRocks数据库的桥梁,允许直接执行SQL和探索数据库,无需复杂的设置或配置。
View on GitHub

Overview

基本能力

产品定位

StarRocks MCP Server 旨在简化AI助手与StarRocks数据库之间的交互,提供直接的SQL执行和数据库探索功能。

核心功能

  • SQL执行:支持SELECT查询和返回结果集的命令(read_query)。
  • 数据库操作:支持DDL/DML等不返回结果集的StarRocks命令(write_query)。
  • 数据库探索:列出所有数据库、表结构、表信息等。
  • 系统信息:通过类似Linux /proc的接口获取StarRocks内部系统信息。

适用场景

  • 数据库管理:通过AI助手直接管理StarRocks数据库。
  • 数据探索:快速查询和探索数据库结构和内容。
  • 系统监控:获取StarRocks集群的节点、事务、任务等系统信息。

工具列表

  • read_query:执行SELECT查询或返回结果集的命令。
  • write_query:执行DDL/DML等不返回结果集的StarRocks命令。

常见问题解答

  • 如何配置StarRocks连接:通过环境变量STARROCKS_HOSTSTARROCKS_PORTSTARROCKS_USERSTARROCKS_PASSWORD配置连接信息。
  • 开发环境运行:如果未安装为Python包,可以通过指定本地目录运行。

使用教程

使用依赖

  • 需要安装Python和uv工具。

安装教程

  1. 作为Python包安装bash pip install mcp-server-starrocks
  2. 开发环境运行bash uv --directory path/to/mcp-server-starrocks run mcp-server-starrocks

调试方式

  1. 检查环境变量:确保STARROCKS_HOSTSTARROCKS_PORTSTARROCKS_USERSTARROCKS_PASSWORD正确设置。
  2. 运行服务bash uv run --with mcp-server-starrocks mcp-server-starrocks
  3. 验证连接:使用read_querywrite_query工具测试数据库连接和操作。

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。