upload: v0.1 code

Author: shaxiaozz

.gitignore

@@ -0,0 +1,25 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env

Dockerfile

@@ -0,0 +1,16 @@
+FROM golang:1.24.2-alpine as builder
+WORKDIR /data/prometheus-mcp-server-code
+ENV GOPROXY=https://goproxy.cn
+RUN apk add --no-cache upx ca-certificates tzdata
+COPY ./go.mod ./
+COPY ./go.sum ./
+RUN go mod download
+COPY . .
+RUN CGO_ENABLED=0 go build -ldflags "-s -w" -o prometheus-mcp-server
+
+FROM golang:1.24.2-alpine as runner
+COPY --from=builder /usr/share/zoneinfo/Asia/Shanghai /etc/localtime
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
+COPY --from=builder /data/prometheus-mcp-server-code/prometheus-mcp-server /prometheus-mcp-server
+EXPOSE 8000
+CMD ["/prometheus-mcp-server"]

LICENSE

@@ -0,0 +1,81 @@
+# Prometheus MCP Server
+[Model Context Protocol][mcp] 这是一个基于Golang开发的Prometheus-MCP-Server,目前只支持sse运行模式
+![img.png](docs/cursor.png)
+
+[mcp]: https://modelcontextprotocol.io
+
+## 功能
+- [x] Prometheus MCP Tools
+  - [x] 列出可用指标 (prometheus_list_metrics)
+  - [x] 发现并探索指标 (prometheus_get_targets)
+  - [x] 获取特定指标的元数据 (prometheus_get_metric_metadata)
+  - [x] 查看即时查询结果 (prometheus_execute_query)
+  - [x] 查看不同步长间隔的范围查询结果 (prometheus_execute_range_query)
+  - [x] 查看最近时长查询结果 (prometheus_execute_last_query)
+- [x] 支持身份验证
+  - [x] 通过环境变量进行基本身份验证
+  - [x] 通过环境变量进行 Bearer Token 身份验证
+- [x] 支持 Docker 容器化
+
+## 使用方法
+
+1. 确保你的prometheus-mcp-server容器可以与prometheus-server通信.
+
+2. 使用以下命令运行prometheus-mcp-server容器
+
+```bash
+# 默认以sse方式运行mcp-server (prometheus无认证)
+# 如需stdio模式,请自行将 MCP_SERVER_TRANSPORT=sse 修改为 MCP_SERVER_TRANSPORT=stdio
+docker run -d --name prometheus-mcp-server \
+  -e PROMETHEUS_URL=http://your-prometheus-server:9090 \
+  -e MCP_SERVER_TRANSPORT=sse \
+  shaxiaozz/prometheus-mcp-server:latest
+```
+
+```bash
+# 默认以sse方式运行mcp-server (prometheus basic auth)
+# 如需stdio模式,请自行将 MCP_SERVER_TRANSPORT=sse 修改为 MCP_SERVER_TRANSPORT=stdio
+docker run -d --name prometheus-mcp-server \
+  -e PROMETHEUS_URL=http://your-prometheus-server:9090 \
+  -e PROMETHEUS_USERNAME=your_username \
+  -e PROMETHEUS_PASSWORD=your_password \
+  -e MCP_SERVER_TRANSPORT=sse \
+  shaxiaozz/prometheus-mcp-server:latest
+```
+
+```bash
+# 默认以sse方式运行mcp-server (prometheus token auth)
+# 如需stdio模式,请自行将 MCP_SERVER_TRANSPORT=sse 修改为 MCP_SERVER_TRANSPORT=stdio
+docker run -d --name prometheus-mcp-server \
+  -e PROMETHEUS_URL=http://your-prometheus-server:9090 \
+  -e PROMETHEUS_TOKEN=your_token \
+  -e MCP_SERVER_TRANSPORT=sse \
+  shaxiaozz/prometheus-mcp-server:latest
+```
+
+3. 将服务器配置添加到客户端配置文件中。例如，Cursor Desktop:  
+
+url可直接通过命令: ```docker logs prometheus-mcp-server``` 查看
+```json
+{
+  "mcpServers": {
+    "prometheus-mcp-server": {
+      "url": "http://10.0.0.1:8000/sse"
+    }
+  }
+}
+```
+![img.png](docs/cursor.png)
+
+## 构建镜像
+```bash
+git clonse https://github.com/shaxiaozz/prometheus-mcp-server.git && cd prometheus-mcp-server
+docker build -t prometheus-mcp-server .
+```
+
+## 致谢
+- [mark3labs/mcp-go](https://github.com/mark3labs/mcp-go)
+- [pab1it0/prometheus-mcp-server](https://github.com/pab1it0/prometheus-mcp-server)
+
+## License
+GNU v3.0

README-zh.md

@@ -0,0 +1,40 @@
+package config
+
+import (
+	"log"
+	"os"
+)
+
+var Config config
+var (
+	PrometheusUrl, PrometheusUserName, PrometheusPassword, PrometheusToken, McpServerTransport string
+)
+
+type config struct {
+}
+
+func (c *config) InitConfig() {
+	if os.Getenv("PROMETHEUS_URL") == "" {
+		log.Fatalf("PROMETHEUS_URL env variable not set")
+	} else {
+		PrometheusUrl = os.Getenv("PROMETHEUS_URL")
+	}
+
+	if os.Getenv("PROMETHEUS_USERNAME") != "" {
+		PrometheusUserName = os.Getenv("PROMETHEUS_USERNAME")
+	}
+
+	if os.Getenv("PROMETHEUS_PASSWORD") != "" {
+		PrometheusPassword = os.Getenv("PROMETHEUS_PASSWORD")
+	}
+
+	if os.Getenv("PROMETHEUS_TOKEN") != "" {
+		PrometheusToken = os.Getenv("PROMETHEUS_TOKEN")
+	}
+
+	if os.Getenv("MCP_SERVER_TRANSPORT") == "" {
+		McpServerTransport = "sse"
+	} else {
+		McpServerTransport = os.Getenv("MCP_SERVER_TRANSPORT")
+	}
+}

config/config.go

@@ -0,0 +1,12 @@
+module github.com/shaxiaozz/prometheus-mcp-server
+
+go 1.24.2
+
+require github.com/mark3labs/mcp-go v0.23.0
+
+require (
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/spf13/cast v1.7.1 // indirect
+	github.com/wonderivan/logger v1.0.0 // indirect
+	github.com/yosida95/uritemplate/v3 v3.0.2 // indirect
+)

docs/cursor.png

@@ -0,0 +1,28 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/frankban/quicktest v1.14.6 h1:7Xjx+VpznH+oBnejlPUj8oUpdxnVs4f8XU8WnHkI4W8=
+github.com/frankban/quicktest v1.14.6/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
+github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
+github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
+github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/mark3labs/mcp-go v0.23.0 h1:NmtoPx4jf7if7bfAynocpVdpXqX5U8X/18c1gddK/QA=
+github.com/mark3labs/mcp-go v0.23.0/go.mod h1:rXqOudj/djTORU/ThxYx8fqEVj/5pvTuuebQ2RC7uk4=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
+github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs=
+github.com/spf13/cast v1.7.1 h1:cuNEagBQEHWN1FnbGEjCXL2szYEXqfJPbP2HNUaca9Y=
+github.com/spf13/cast v1.7.1/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/wonderivan/logger v1.0.0 h1:Z6Nz+3SNcizolx3ARH11axdD4DXjFpb2J+ziGUVlv/U=
+github.com/wonderivan/logger v1.0.0/go.mod h1:NObMfQ3WOLKfYEZuGeZQfuQfSPE5+QNgRddVMzsAT/k=
+github.com/yosida95/uritemplate/v3 v3.0.2 h1:Ed3Oyj9yrmi9087+NczuL5BwkIc4wvTb5zIM+UJPGz4=
+github.com/yosida95/uritemplate/v3 v3.0.2/go.mod h1:ILOh0sOhIJR3+L/8afwt/kE++YT040gmv5BQTMR2HP4=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

go.mod

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"fmt"
+	"github.com/mark3labs/mcp-go/server"
+	"github.com/shaxiaozz/prometheus-mcp-server/config"
+	"github.com/shaxiaozz/prometheus-mcp-server/prometheus"
+	"github.com/shaxiaozz/prometheus-mcp-server/utils"
+	"github.com/wonderivan/logger"
+	"log"
+)
+
+func init() {
+	config.Config.InitConfig()
+}
+
+var (
+	Version = utils.Version
+)
+
+func newMCPServer() *server.MCPServer {
+	return server.NewMCPServer(
+		"github.com/shaxiaozz/prometheus-mcp-server",
+		Version,
+		server.WithToolCapabilities(true),
+		server.WithResourceCapabilities(true, true),
+		server.WithLogging(),
+		server.WithRecovery(),
+	)
+}
+
+func addTools(s *server.MCPServer) {
+	s.AddTool(prometheus.HelloWorldTool, prometheus.HelloWorldToolHandle)               // Say hello to someone
+	s.AddTool(prometheus.ListMetricsTool, prometheus.ListMetricsToolHandle)             // List all available metrics in Prometheus
+	s.AddTool(prometheus.GetTargetsTool, prometheus.GetTargetsToolHandle)               // Get information about all scrape targets
+	s.AddTool(prometheus.GetMetricMetadataTool, prometheus.GetMetricMetadataToolHandle) // Get metadata for a specific metric
+	s.AddTool(prometheus.ExecuteQueryTool, prometheus.ExecuteQueryToolHandle)           // Execute a PromQL instant query against Prometheus
+	s.AddTool(prometheus.ExecuteRangeQueryTool, prometheus.ExecuteRangeQueryToolHandle) // Execute a PromQL range query with start time, end time, and step interval.
+	s.AddTool(prometheus.ExecuteLastQueryTool, prometheus.ExecuteLastQueryToolHandle)   // Executes a PromQL range query with a recent time and a step interval. The recent time is in minutes
+}
+
+func runServer(transport string) error {
+	mcpServer := newMCPServer()
+	addTools(mcpServer)
+	ipAddr := utils.GetIPAddr()
+	address := ipAddr + ":8000"
+
+	if transport == "sse" {
+		logger.Info("SSE server listening on http://" + address)
+		sseServer := server.NewSSEServer(mcpServer, server.WithBaseURL("http://"+address))
+		if err := sseServer.Start(address); err != nil {
+			log.Fatalf("Server error: %v", err)
+		}
+	} else {
+		logger.Info("Run Stdio server")
+		if err := server.ServeStdio(mcpServer); err != nil {
+			log.Fatalf("Server error: %v", err)
+		}
+	}
+	return nil
+}
+
+func main() {
+	if err := runServer(config.McpServerTransport); err != nil {
+		fmt.Printf("server run error: %v\n", err)
+		panic(err)
+	}
+}

go.sum

@@ -0,0 +1,26 @@
+package prometheus
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"github.com/mark3labs/mcp-go/mcp"
+	"github.com/wonderivan/logger"
+)
+
+const (
+	HelloWorld = "hello_world"
+)
+
+var HelloWorldTool = mcp.NewTool(HelloWorld, mcp.WithDescription(
+	"Say hello to someone"))
+
+func HelloWorldToolHandle(ctx context.Context, request mcp.CallToolRequest) (*mcp.CallToolResult, error) {
+	logger.Info("Call HelloWorldToolHandle")
+	name, ok := request.Params.Arguments["name"].(string)
+	if !ok {
+		return nil, errors.New("name must be a string")
+	}
+
+	return mcp.NewToolResultText(fmt.Sprintf("Hello, %s!", name)), nil
+}