https://github.com/grafana/mcp-grafana
MCP server for Grafana
https://github.com/grafana/mcp-grafana
Last synced: 4 days ago
JSON representation
MCP server for Grafana
- Host: GitHub
- URL: https://github.com/grafana/mcp-grafana
- Owner: grafana
- License: apache-2.0
- Created: 2024-12-24T15:44:23.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-04-04T16:03:31.000Z (12 days ago)
- Last Synced: 2025-04-05T12:01:47.772Z (11 days ago)
- Language: Go
- Size: 594 KB
- Stars: 299
- Watchers: 109
- Forks: 25
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-mcp-list - grafana/mcp-grafana - grafana?style=social)](https://github.com/grafana/mcp-grafana): Searches dashboards and queries datasources in Grafana. (Uncategorized / Uncategorized)
- awesome-mcp-servers - grafana/mcp-grafana - Search dashboards, investigate incidents and query datasources in your Grafana instance (Legend / 📊 <a name="monitoring"></a>Monitoring)
- awesome-mcp-servers - grafana/mcp-grafana - Search dashboards, investigate incidents and query datasources in your Grafana instance (Legend / 📊 <a name="monitoring"></a>Monitoring)
- Awesome-MCP-Servers-directory - Grafana - Search dashboards, investigate incidents and query datasources in your Grafana instance (Monitoring)
- awesome-mcp-servers - Grafana MCP - Provides programmatic access to Grafana dashboards, data sources, and alerting features via the Model Context Protocol (Table of Contents / Monitoring)
- awesome-mcp-servers - Grafana MCP - Provides programmatic access to Grafana dashboards, data sources, and alerting features via the Model Context Protocol (Table of Contents / Monitoring)
- awesome-mcp-servers - Grafana - Search dashboards, investigate incidents and query datasources in your Grafana instance (Official Servers)
README
# Grafana MCP server
A [Model Context Protocol][mcp] (MCP) server for Grafana.
This provides access to your Grafana instance and the surrounding ecosystem.
## Features
- [x] Search for dashboards
- [x] Get dashboard by UID
- [x] List and fetch datasource information
- [ ] Query datasources
- [x] Prometheus
- [x] Loki
- [x] Log queries
- [x] Metric queries
- [ ] Tempo
- [ ] Pyroscope
- [x] Query Prometheus metadata
- [x] Metric metadata
- [x] Metric names
- [x] Label names
- [x] Label values
- [x] Query Loki metadata
- [x] Label names
- [x] Label values
- [x] Stats
- [x] Search, create, update and close incidents
- [ ] Start Sift investigations and view the results
- [ ] Alerting
- [x] List and fetch alert rule information
- [ ] Get alert rule statuses (firing/normal/error/etc.)
- [ ] Create and change alert rules
- [ ] List contact points
- [ ] Create and change contact points
- [x] Access Grafana OnCall functionality
- [x] List and manage schedules
- [x] Get shift details
- [x] Get current on-call users
- [x] List teams and users
- [ ] List alert groups
The list of tools is configurable, so you can choose which tools you want to make available to the MCP client.
This is useful if you don't use certain functionality or if you don't want to take up too much of the context window.
### Tools
| Tool | Category | Description |
|-----------------------------------|-------------|--------------------------------------------------------------------|
| `search_dashboards` | Search | Search for dashboards |
| `get_dashboard_by_uid` | Dashboard | Get a dashboard by uid |
| `list_datasources` | Datasources | List datasources |
| `get_datasource_by_uid` | Datasources | Get a datasource by uid |
| `get_datasource_by_name` | Datasources | Get a datasource by name |
| `query_prometheus` | Prometheus | Execute a query against a Prometheus datasource |
| `list_prometheus_metric_metadata` | Prometheus | List metric metadata |
| `list_prometheus_metric_names` | Prometheus | List available metric names |
| `list_prometheus_label_names` | Prometheus | List label names matching a selector |
| `list_prometheus_label_values` | Prometheus | List values for a specific label |
| `list_incidents` | Incident | List incidents in Grafana Incident |
| `create_incident` | Incident | Create an incident in Grafana Incident |
| `add_activity_to_incident` | Incident | Add an activity item to an incident in Grafana Incident |
| `resolve_incident` | Incident | Resolve an incident in Grafana Incident |
| `query_loki_logs` | Loki | Query and retrieve logs using LogQL (either log or metric queries) |
| `list_loki_label_names` | Loki | List all available label names in logs |
| `list_loki_label_values` | Loki | List values for a specific log label |
| `query_loki_stats` | Loki | Get statistics about log streams |
| `list_alert_rules` | Alerting | List alert rules |
| `get_alert_rule_by_uid` | Alerting | Get alert rule by UID |
| `list_oncall_schedules` | OnCall | List schedules from Grafana OnCall |
| `get_oncall_shift` | OnCall | Get details for a specific OnCall shift |
| `get_current_oncall_users` | OnCall | Get users currently on-call for a specific schedule |
| `list_oncall_teams` | OnCall | List teams from Grafana OnCall |
| `list_oncall_users` | OnCall | List users from Grafana OnCall |
## Usage
1. Create a service account in Grafana with enough permissions to use the tools you want to use,
generate a service account token, and copy it to the clipboard for use in the configuration file.
Follow the [Grafana documentation][service-account] for details.
2. Download the latest release of `mcp-grafana` from the [releases page](https://github.com/grafana/mcp-grafana/releases) and place it in your `$PATH`.
If you have a Go toolchain installed you can also build and install it from source, using the `GOBIN` environment variable
to specify the directory where the binary should be installed. This should also be in your `PATH`.
```bash
GOBIN="$HOME/go/bin" go install github.com/grafana/mcp-grafana/cmd/mcp-grafana@latest
```
3. Add the server configuration to your client configuration file. For example, for Claude Desktop:
```json
{
"mcpServers": {
"grafana": {
"command": "mcp-grafana",
"args": [],
"env": {
"GRAFANA_URL": "http://localhost:3000",
"GRAFANA_API_KEY": ""
}
}
}
}
```
> Note: if you see `Error: spawn mcp-grafana ENOENT` in Claude Desktop, you need to specify the full path to `mcp-grafana`.
## Development
Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.
This project is written in Go. Install Go following the instructions for your platform.
To run the server, use:
```bash
make run
```
You can also run the server using the SSE transport inside Docker. To build the image, use
```
make build-image
```
And to run the image, use:
```
docker run -it --rm -p 8000:8000 mcp-grafana:latest
```
### Testing
There are three types of tests available:
1. Unit Tests (no external dependencies required):
```bash
make test-unit
```
You can also run unit tests with:
```bash
make test
```
2. Integration Tests (requires docker containers to be up and running):
```bash
make test-integration
```
3. Cloud Tests (requires cloud Grafana instance and credentials):
```bash
make test-cloud
```
> Note: Cloud tests are automatically configured in CI. For local development, you'll need to set up your own Grafana Cloud instance and credentials.
More comprehensive integration tests will require a Grafana instance to be running locally on port 3000; you can start one with Docker Compose:
```bash
docker-compose up -d
```
The integration tests can be run with:
```bash
make test-all
```
If you're adding more tools, please add integration tests for them. The existing tests should be a good starting point.
### Linting
To lint the code, run:
```bash
make lint
```
## License
This project is licensed under the [Apache License, Version 2.0](LICENSE).
[mcp]: https://modelcontextprotocol.io/
[service-account]: https://grafana.com/docs/grafana/latest/administration/service-accounts/