Skip to content

Commit 446f29f

Browse files
committed
fix: README
1 parent c286a8b commit 446f29f

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

README.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Prometheus MCP Server
2+
[Model Context Protocol][mcp] 这是一个基于Golang开发的Prometheus-MCP-Server,目前只支持sse运行模式
3+
![img.png](docs/cursor.png)
4+
5+
[mcp]: https://modelcontextprotocol.io
6+
7+
## 功能
8+
- [x] Prometheus MCP Tools
9+
- [x] 列出可用指标 (prometheus_list_metrics)
10+
- [x] 发现并探索指标 (prometheus_get_targets)
11+
- [x] 获取特定指标的元数据 (prometheus_get_metric_metadata)
12+
- [x] 查看即时查询结果 (prometheus_execute_query)
13+
- [x] 查看不同步长间隔的范围查询结果 (prometheus_execute_range_query)
14+
- [x] 查看最近时长查询结果 (prometheus_execute_last_query)
15+
- [x] 支持身份验证
16+
- [x] 通过环境变量进行基本身份验证
17+
- [x] 通过环境变量进行 Bearer Token 身份验证
18+
- [x] 支持 Docker 容器化
19+
20+
## 使用方法
21+
22+
1. 确保你的prometheus-mcp-server容器可以与prometheus-server通信.
23+
24+
2. 使用以下命令运行prometheus-mcp-server容器
25+
26+
```bash
27+
# 默认以sse方式运行mcp-server (prometheus无认证)
28+
# 如需stdio模式,请自行将 MCP_SERVER_TRANSPORT=sse 修改为 MCP_SERVER_TRANSPORT=stdio
29+
docker run -d --name prometheus-mcp-server \
30+
-e PROMETHEUS_URL=http://your-prometheus-server:9090 \
31+
-e MCP_SERVER_TRANSPORT=sse \
32+
shaxiaozz/prometheus-mcp-server:latest
33+
```
34+
35+
```bash
36+
# 默认以sse方式运行mcp-server (prometheus basic auth)
37+
# 如需stdio模式,请自行将 MCP_SERVER_TRANSPORT=sse 修改为 MCP_SERVER_TRANSPORT=stdio
38+
docker run -d --name prometheus-mcp-server \
39+
-e PROMETHEUS_URL=http://your-prometheus-server:9090 \
40+
-e PROMETHEUS_USERNAME=your_username \
41+
-e PROMETHEUS_PASSWORD=your_password \
42+
-e MCP_SERVER_TRANSPORT=sse \
43+
shaxiaozz/prometheus-mcp-server:latest
44+
```
45+
46+
```bash
47+
# 默认以sse方式运行mcp-server (prometheus token auth)
48+
# 如需stdio模式,请自行将 MCP_SERVER_TRANSPORT=sse 修改为 MCP_SERVER_TRANSPORT=stdio
49+
docker run -d --name prometheus-mcp-server \
50+
-e PROMETHEUS_URL=http://your-prometheus-server:9090 \
51+
-e PROMETHEUS_TOKEN=your_token \
52+
-e MCP_SERVER_TRANSPORT=sse \
53+
shaxiaozz/prometheus-mcp-server:latest
54+
```
55+
56+
3. 将服务器配置添加到客户端配置文件中。例如,Cursor Desktop:
57+
58+
url可直接通过命令: ```docker logs prometheus-mcp-server``` 查看
59+
```json
60+
{
61+
"mcpServers": {
62+
"prometheus-mcp-server": {
63+
"url": "http://10.0.0.1:8000/sse"
64+
}
65+
}
66+
}
67+
```
68+
![img.png](docs/cursor.png)
69+
70+
## 构建镜像
71+
```bash
72+
git clonse https://github.com/shaxiaozz/prometheus-mcp-server.git && cd prometheus-mcp-server
73+
docker build -t prometheus-mcp-server .
74+
```
75+
76+
## 致谢
77+
- [mark3labs/mcp-go](https://github.com/mark3labs/mcp-go)
78+
- [pab1it0/prometheus-mcp-server](https://github.com/pab1it0/prometheus-mcp-server)
79+
80+
## License
81+
GNU v3.0

0 commit comments

Comments
 (0)