MCP Grafana

🚀 Grafana Usage Documentation

Grafana is a powerful open - source monitoring and visualization platform. It supports multiple data sources and offers a wide range of charting and alerting features. To facilitate integration with the Model Context Protocol (MCP), the mcp - grafana tool is provided, allowing interaction with the Grafana service via the MCP protocol.

🚀 Quick Start

✨ Features

• Grafana is an open - source monitoring and visualization platform with support for multiple data sources and rich charting and alerting features.
• The mcp - grafana tool enables integration with the MCP protocol.

📦 Installation

1. Create a service account and obtain an API Token Create a service account in Grafana and grant it sufficient permissions to use the required tools. Generate a service account token and copy it to the clipboard for subsequent configuration. For detailed steps, refer to the [Grafana documentation](https://grafana.com/docs/grafana/latest/administration/service - accounts/).
2. Download and install mcp - grafana Download the latest version of mcp - grafana from the [release page](https://github.com/grafana/mcp - grafana/releases) and add it to the system path. If using the Go toolchain, you can install it with the following command:

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

3. Configure the service Add the following configuration to your client configuration file (e.g., for Claude Desktop):

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

   ⚠️ Important Note

   If you see Error: spawn mcp - grafana ENOENT in Claude Desktop, you need to specify the full path of mcp - grafana.

💻 Usage Examples

Basic Usage

You can enable debug mode by adding the -debug flag to get detailed HTTP request and response logs. Update the Claude Desktop configuration as follows:

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

🔧 Technical Details

The project is written in Go. To install Go, refer to the instructions for your platform.

To run the server, you can execute:

make run

You can also run it in Docker via SSE transmission:

make build - image

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

📚 Documentation

There are three types of tests:

1. Unit tests: Verify the behavior of individual functions.
2. Integration tests: Test the interaction between components.
3. Cloud tests: Tests run in a cloud environment. When executing tests, please pay attention to the following requirements and steps.

📄 License

This project is licensed under the MIT License, which allows for free use, modification, and distribution, provided that the copyright notice is retained.