Grafana MCP

Grafana MCP

此项目提供适用于 Grafana 的 MCP 服务，其中包含用于与 Grafana 仪表板、数据源、告警等交互的 MCP 工具。

此软件包包含一个仪表板模板资源，安装软件包时会将其正确打包，以供使用。

用法

安装

1. 创建虚拟环境（推荐）

python -m venv venv
source venv/bin/activate

2. 使用 pip 直接从 GitHub 安装此软件包：

pip install -e git+https://github.com/izaitsevfb/grafana-mcp.git#egg=grafana_mcp

（或者，也可以在本地使用 pip install -e . 安装）

3. 配置 Grafana 身份验证

创建一个 .env 文件，填写 Grafana URL 和 API 令牌：

cp .env.example .env

然后编辑 .env 文件，填入实际的 Grafana URL 和 API 令牌：

GRAFANA_URL=http://your-grafana-server:3000
GRAFANA_API_TOKEN=your-api-token-here

你可以在 Grafana 中依次前往：配置 → API 密钥 → 新建 API 密钥，生成 API 令牌。

4. 安装完成后，可以按如下方式运行 MCP 服务：

python -m grafana_mcp

5. 将此 MCP 服务添加到 Claude Code：

claude mcp add-json grafana '{ "type": "stdio", "command": "python", "args": [ "-m", "grafana_mcp" ], "env": {} }'

注意：默认情况下，MCP 配置仅应用于当前目录。如果要全局使用，请在上面的命令中添加 --scope user：

claude mcp add-json --scope user grafana '{ "type": "stdio", "command": "python", "args": [ "-m", "grafana_mcp" ], "env": {} }'

6. 按照平常的方式运行 Claude Code：

claude

开发

开发环境安装

1. 克隆代码仓库
2. 以开发模式安装：

   pip install -e .
   

此软件包使用 Python 的包资源管理系统来包含仪表板模板。dashboard.json 文件存储在 src/grafana_mcp/ 目录中，软件包安装后会使用 importlib.resources 访问该文件。

测试

运行单元测试：

python -m unittest discover tests

使用令牌身份验证进行测试时，请确保已按照上文说明创建包含 Grafana 凭据的 .env 文件。测试套件包含模拟测试，无需连接实际的 Grafana 实例。

工具

Grafana MCP 提供以下工具：

可用工具

仪表板管理

• get_grafana_info()：获取已连接的 Grafana 实例信息，包括版本和连接状态
• list_dashboards()：列出已连接的 Grafana 实例中的所有仪表板
• get_dashboard(uid)：按 UID 获取特定仪表板的详细信息

组织管理

• get_organization()：获取当前组织的信息

数据源管理

• list_datasources()：列出所有可用的数据源

要求

• grafana-client：Grafana API 的 Python 客户端
• python-dotenv：用于从 .env 文件加载环境变量
• mcp：模型上下文协议服务实现

身份验证

此软件包使用令牌通过 Grafana API 进行身份验证。配置身份验证的步骤如下：

1. 在 Grafana 实例中创建具有适当权限的 API 密钥
2. 创建一个 .env 文件，并设置以下变量：

   GRAFANA_URL=http://your-grafana-url:3000
   GRAFANA_API_TOKEN=your-api-token-here
   

3. MCP 服务启动时会自动加载这些凭据

后续版本将添加更多工具和功能。