https://github.com/StarRocks/mcp-server-starrocks
StarRocks MCP (Model Context Protocol) Server
https://github.com/StarRocks/mcp-server-starrocks
agent ai database mcp-server model-context-protocol starrocks
Last synced: 8 months ago
JSON representation
StarRocks MCP (Model Context Protocol) Server
- Host: GitHub
- URL: https://github.com/StarRocks/mcp-server-starrocks
- Owner: StarRocks
- License: apache-2.0
- Created: 2025-03-05T10:48:25.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-11T13:14:26.000Z (8 months ago)
- Last Synced: 2025-03-11T13:25:27.246Z (8 months ago)
- Topics: agent, ai, database, mcp-server, model-context-protocol, starrocks
- Language: Python
- Homepage:
- Size: 23.4 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp-zh - StarRocks
- awesome-mcp-servers - **mcp-server-starrocks** - StarRocks MCP (Model Context Protocol) Server `python` `agent` `ai` `database` `mcp-server` `pip install git+https://github.com/StarRocks/mcp-server-starrocks` (🤖 AI/ML)
- awesome-mcp-servers - **mcp-server-starrocks** - StarRocks MCP (Model Context Protocol) Server `python` `agent` `ai` `database` `mcp-server` `pip install git+https://github.com/StarRocks/mcp-server-starrocks` (AI/ML)
- Awesome-MCP-Servers-directory - StarRocks - Interact with StarRocks (Databases)
- Awesome-Official-MCP-Servers - StarRocks - server-starrocks?style=social) | Interact with [StarRocks](https://www.starrocks.io/) | | (官方 MCP 服务器列表)
- awesome-mcp-servers - StarRocks - StarRocks MCP (Model Context Protocol) Server (Table of Contents / Databases)
- awesome-mcp-servers - StarRocks - Interact with [StarRocks](https://www.starrocks.io/) (Official Servers)
- Awesome-Official-MCP-Servers - StarRocks - server-starrocks?style=social) | Interact with [StarRocks](https://www.starrocks.io/) | | (官方 MCP 服务器列表)
- metorial-index - StarRocks MCP Server - Connects AI assistants to StarRocks databases for executing SQL queries and exploring database schemas with ease. Provides capabilities for data visualization and detailed data overview retrieval without complex setups. (Cloud Services)
README
# Starrocks Official MCP server
The StarRocks MCP Server acts as a bridge between AI assistants and StarRocks databases, allowing for direct SQL execution and database exploration without requiring complex setup or configuration.
## Configuration
MCP server config
```json
{
"mcpServers": {
"mcp-server-starrocks": {
"command": "uv",
"args": [
"run",
"--with",
"mcp-server-starrocks",
"mcp-server-starrocks"
],
"env": {
"STARROCKS_HOST": "default localhost",
"STARROCKS_PORT": "default 9030",
"STARROCKS_USER": "default root",
"STARROCKS_PASSWORD": "default empty"
}
}
}
}
```
If mcp-server-starrocks is not installed as python package(in dev env), can run using local dir
```json
{
"mcpServers": {
"mcp-server-starrocks": {
"command": "uv",
"args": [
"--directory",
"path/to/mcp-server-starrocks",
"run",
"mcp-server-starrocks"
],
"env": {
"STARROCKS_HOST": "default localhost",
"STARROCKS_PORT": "default 9030",
"STARROCKS_USER": "default root",
"STARROCKS_PASSWORD": "default empty"
}
}
}
}
```
## Components
### Tools
* `read_query`
- Execute a SELECT query or commands that return a ResultSet
* `write_query`
- Execute an DDL/DML or other StarRocks command that do not have a ResultSet
### Resources
#### Direct Resources
* `starrocks:///databases`
- Lists all databases in StarRocks
#### Resource Templates
* `starrocks:///{db}/{table}/schema`
- Gets the schema of a table using SHOW CREATE TABLE
* `starrocks:///{db}/tables`
- Lists all tables in a specific database
* `proc:///{+path}`
- System internal information exposed by StarRocks similar to linux /proc
- Common paths include:
- `/frontends` - Shows the information of FE nodes
- `/backends` - Shows the information of BE nodes if this SR is non cloud native deployment
- `/compute_nodes` - Shows the information of CN nodes if this SR is cloud native deployment
- `/dbs` - Shows the information of databases
- `/dbs/` - Shows the information of a database by database ID
- `/dbs//` - Shows the information of tables by database ID
- `/dbs///partitions` - Shows the information of partitions by database ID and table ID
- `/transactions` - Shows the information of transactions by database
- `/transactions/` - Shows the information of transactions by database ID
- `/transactions//running` - Shows the information of running transactions by database ID
- `/transactions//finished` - Shows the information of finished transactions by database ID
- `/jobs` - Shows the information of jobs
- `/statistic` - Shows the statistics of each database
- `/tasks` - Shows the total number of all generic tasks and the failed tasks
- `/cluster_balance` - Shows the load balance information
- `/routine_loads` - Shows the information of Routine Load
- `/colocation_group` - Shows the information of Colocate Join groups
- `/catalog` - Shows the information of catalogs
### Prompts
None