mcp-grafana

🚀 Grafana 使用文档

Grafana 是一款功能强大的开源监控与可视化平台，它支持多种数据源，还具备丰富的图表展示和报警功能。为了便于与 Model Context Protocol (MCP) 集成，特意推出了 mcp-grafana 工具，借助该工具能够通过 MCP 协议与 Grafana 服务进行交互。

🚀 快速开始

✨ 主要特性

• Grafana 是强大的开源监控和可视化平台，支持多数据源，有丰富图表和报警功能。
• 提供 mcp-grafana 工具，方便与 MCP 集成，可通过 MCP 协议与 Grafana 服务交互。

📦 安装指南

1. 创建服务账号并获取 API Token
   在 Grafana 中创建一个服务账号，并赋予其足够的权限以使用所需工具。生成服务账号令牌后，将其复制到剪贴板，用于后续配置。详细步骤可参考 Grafana 文档。
2. 下载并安装 mcp-grafana
   从 发布页面 下载最新版本的 mcp-grafana，并将其添加到系统路径中。若使用 Go 工具链，可通过以下命令进行安装：

GOBIN="$HOME/go/bin" go install github.com/grafana/mcp-grafana/cmd/mcp-grafana@latest

3. 配置服务
   将以下配置添加到你的客户端配置文件中（例如用于 Claude Desktop）：

{
  "mcpServers": {
    "grafana": {
      "command": "mcp-grafana",
      "args": [],
      "env": {
        "GRAFANA_URL": "http://localhost:3000",
        "GRAFANA_API_KEY": "<your service account token>"
      }
    }
  }
}

⚠️ 重要提示

如果在 Claude Desktop 中看到 Error: spawn mcp-grafana ENOENT，需要指定完整的 mcp-grafana 路径。

💻 使用示例

基础用法

可以通过添加 -debug 标志启用调试模式，以获得详细的 HTTP 请求和响应日志。在 Claude Desktop 配置中更新如下：

{
  "mcpServers": {
    "grafana": {
      "command": "mcp-grafana",
      "args": ["-debug"],
      "env": {
        "GRAFANA_URL": "http://localhost:3000",
        "GRAFANA_API_KEY": "<your service account token>"
      }
    }
  }
}

🔧 技术细节

开发

欢迎贡献！如果对项目有建议或改进，请提交问题或拉取请求。 该项目使用 Go 编写。安装 Go，请参考相应平台的说明。 要运行服务器，可以执行：

make run

也可以通过 SSE 传输在 Docker 中运行：

make build-image

docker run -it --rm -p 8000:8000 mcp-grafana:latest

测试

有三种类型的测试：

1. 单元测试：验证单个函数的行为。
2. 集成测试：测试组件间的交互。
3. 云测试：在云环境中运行的测试。 执行测试时，请注意以下要求和步骤。

📄 许可证

该项目遵循 MIT License，允许自由使用、修改和分发，但需保留版权声明。