Grafana

by grafana

3.2k stars
1.5k downloads
Not rated
GitHub

About

Search dashboards, investigate incidents and query datasources in your Grafana instance

Details

Author
grafana
GitHub stars
3,217
Downloads
1,515
Categories
Developer Tools, Other, Infrastructure, Search, Knowledge Base

- Search, get, update, and patch dashboards
- Query Prometheus, Loki, ClickHouse, and other datasources
- Manage alert rules, notification policies, and contact points
- Create and update Grafana incidents
- View and manage Grafana OnCall schedules and alert groups
- List teams, users, and roles (admin tools, disabled by default)

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Grafana
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install via uv and add the server to your MCP client configuration (e.g., Claude Desktop, Cursor) with the GRAFANA_URL and GRAFANA_SERVICE_ACCOUNT_TOKEN environment variables. Alternative installation methods include Docker, binary, and Helm.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

McpServers

{
    "grafana": {
        "command": "uvx",
        "args": [
            "mcp-grafana"
        ],
        "env": {
            "GRAFANA_URL": "http://localhost:3000",
            "GRAFANA_SERVICE_ACCOUNT_TOKEN": "<your service account token>"
        }
    }
}
# Grafana MCP server [![Unit Tests](https://github.com/grafana/mcp-grafana/actions/workflows/unit.yml/badge.svg)](https://github.com/grafana/mcp-grafana/actions/workflows/unit.yml) [![Integration Tests](https://github.com/grafana/mcp-grafana/actions/workflows/integration.yml/badge.svg)](https://github.com/grafana/mcp-grafana/actions/workflows/integration.yml) [![E2E Tests](https://github.com/grafana/mcp-grafana/actions/workflows/e2e.yml/badge.svg)](https://github.com/grafana/mcp-grafana/actions/workflows/e2e.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/grafana/mcp-grafana.svg)](https://pkg.go.dev/github.com/grafana/mcp-grafana) [![MCP Catalog](https://archestra.ai/mcp-catalog/api/badge/quality/grafana/mcp-grafana)](https://archestra.ai/mcp-catalog/grafana__mcp-grafana) A [Model Context Protocol][mcp] (MCP) server for Grafana. This provides access to your Grafana instance and the surrounding ecosystem. ## Quick Start Requires [uv](https://docs.astral.sh/uv/getting-started/installation/). Add the following to your MCP client configuration (e.g. Claude Desktop, Cursor): ```json { "mcpServers": { "grafana": { "command": "uvx", "args": ["mcp-grafana"], "env": { "GRAFANA_URL": "http://localhost:3000", "GRAFANA_SERVICE_ACCOUNT_TOKEN": "<your service account token>" } } } } ``` For Grafana Cloud, replace `GRAFANA_URL` with your instance URL (e.g. `https://myinstance.grafana.net`). See [Usage](#usage) for more installation options including Docker, binary, and Helm. ## Requirements - **Grafana version 9.0 or later** is required for full functionality. Some features, particularly datasource-related operations, may not work correctly with earlier versions due to missing API endpoints. ## Features _The following features are currently available in MCP server. This list is for informational purposes only and does not represent a roadmap or commitment to future features._ ### Dashboards - **Search for dashboards:** Find dashboards by title or other metadata - **Get dashboard by UID:** Retrieve full dashboard details using its unique identifier. _Warning: Large dashboards can consume significant context window space._ - **Get dashboard summary:** Get a compact overview of a dashboard including title, panel count, panel types, variables, and metadata without the full JSON to minimize context window usage - **Get dashboard property:** Extract specific parts of a dashboard using JSONPath expressions (e.g., `$.title`, `$.panels[*].title`) to fetch only needed data and reduce context window consumption - **Update or create a dashboard:** Modify existing dashboards or create new ones. _Warning: Requires full dashboard JSON which can consume large amounts of context window space._ - **Patch dashboard:** Apply specific changes to a dashboard without requiring the full JSON, significantly reducing context window usage for targeted modifications - **Get panel queries and datasource info:** Get the title, query string, and datasource information (including UID and type, if available) from every panel in a dashboard ### Run Panel Query > **Note:** Run panel query tools are **disabled by default**. To enable them, add `runpanelquery` to your `--enabled-tools` flag. - **Run panel query:** Execute a dashboard panel's query with custom time ranges and variable overrides. #### Context Window Management The dashboard tools now include several strategies to manage context window usage effectively ([issue #101](https://github.com/grafana/mcp-grafana/issues/101)): - **Use `get_dashboard_summary`** for dashboard overview and planning modifications - **Use `get_dashboard_property`** with JSONPath when you only need specific dashboard parts - **Avoid `get_dashboard_by_uid`** unless you specifically need the complete dashboard JSON ### Datasources - **List and fetch datasource information:** View all configured datasources and retrieve detailed information about each. - _Supported datasource types: Prometheus, Loki, ClickHouse, CloudWatch, Elasticsearch, OpenSearch, Snowflake, Athena._ ### Query Examples > **Note:** Query examples tools are **disabled by default**. To enable them, add `examples` to your `--enabled-tools` flag. - **Get query examples:** Retrieve example queries for different datasource types to learn query syntax. ### Prometheus Querying - **Query Prometheus:** Execute PromQL queries (supports both instant and range metric queries) against Prometheus datasources. - **Query Prometheus metadata:** Retrieve metric metadata, metric names, label names, and label values from Prometheus datasources. - **Query histogram percentiles:** Calculate histogram percentile values (p50, p90, p95, p99) using histogram_quantile. ### Loki Querying - **Query Loki logs and metrics:** Run both log queries and metric queries using LogQL against Loki datasources. - **Query Loki metadata:** Retrieve label names, label values, and stream statistics from Loki datasources. - **Query Loki patterns:** Retrieve log patterns detected by Loki to identify common log structures and anomalies. ### InfluxDB Querying > **Note:** InfluxDB tools are **disabled by default**. To enable them, add `influxdb` to your `--enabled-tools` flag. - **Query InfluxDB:** Execute queries against InfluxDB datasources using either InfluxQL (v1.x) or Flux (v2.x). The dialect is inferred from the datasource configuration, or can be set explicitly via the `dialect` parameter. ### ClickHouse Querying > **Note:** ClickHouse tools are **disabled by default**. To enable them, add `clickhouse` to your `--enabled-tools` flag. - **List ClickHouse tables:** List all tables in a ClickHouse database with row counts and sizes. - **Describe table schema:** Get column names, types, and metadata for a ClickHouse table. - **Query ClickHouse:** Execute SQL queries with Grafana macro and variable substitution support. ### CloudWatch Querying > **Note:** CloudWatch tools are **disabled by default**. To enable them, add `cloudwatch` to your `--enabled-tools` flag. - **List CloudWatch namespaces:** Discover available AWS CloudWatch namespaces. - **List CloudWatch metrics:** List metrics available in a specific namespace. - **List CloudWatch dimensions:** Get dimensions for filtering metric queries. - **Query CloudWatch:** Execute CloudWatch metric queries with time range support. ### Graphite Querying > **Note:** Graphite tools are **disabled by default**. To enable them, add `graphite` to your `--enabled-tools` flag. - **Query Graphite:** Execute Graphite render API queries against a Graphite datasource. - **List Graphite metrics:** Browse and discover Graphite metric paths. - **List Graphite tags:** List available Graphite tags and tag values. - **Query Graphite density:** Query Graphite metric density for a given pattern. ### Athena Querying > **Note:** Athena tools are **disabled by default**. To enable them, add `athena` to your `--enabled-tools` flag. - **List Athena catalogs:** Discover available data catalogs (e.g. AwsDataCatalog, Iceberg connectors). - **List Athena databases:** List databases in an Athena catalog. - **List Athena tables:** List tables in an Athena database. - **Describe Athena table:** Get column names for an Athena table. - **Query Athena:** Execute SQL queries against Amazon Athena via Grafana with macro substitution, limit enforcement, and template variable support. ### Snowflake Querying > **Note:** Snowflake tools are **disabled by default**. To enable them, add `snowflake` to your `--enabled-tools` flag. Queries go through Grafana's Snowflake datasource (Grafana Enterprise plugin `grafana-snowflake-datasource`), so authentication is handled by the datasource configuration in Grafana — credentials are never seen by the MCP server. This is the same model used for the ClickHouse tools. - **List Snowflake tables:** Discover tables (with database, schema, kind, row count, and size) via `INFORMATION_SCHEMA.TABLES`. Optional database/schema filters. - **Describe table schema:** Get column names, data types, nullability, defaults, and comments for a Snowflake table. - **Query Snowflake:** Execute SQL queries with macro and variable substitution support. Useful for querying Snowflake's event tables (e.g. `SNOWFLAKE.TELEMETRY.EVENTS`) for logs and traces, or any user table. - Supported macros: `$__timeFilter(column)`, `$__timeFrom`, `$__timeTo`, `$__from`, `$__to` (Unix ms), `$__interval` (seconds), `$__interval_ms`, and `${varname}` for template variable substitution. ### Elasticsearch/OpenSearch Querying > **Note:** Elasticsearch/OpenSearch tools are **disabled by default**. To enable them, add `elasticsearch` to your `--enabled-tools` flag. - **Query Elasticsearch/OpenSearch:** Execute search queries against Elasticsearch or OpenSearch datasources using either Lucene query syntax or Elasticsearch Query DSL. Supports filtering by time range and retrieving logs, metrics, or any indexed data. Returns documents with their index, ID, source fields, and optional relevance score. ### Quickwit Querying > **Note:** Quickwit tools are **disabled by default**. To enable them, add `quickwit` to your `--enabled-tools` flag. - **Query Quickwit:** Execute search queries against Quickwit datasources using Lucene query syntax or partial Elasticsearch-compatible Query DSL. Supports filtering by time range and retrieving logs or other indexed documents. Returns documents with their index, ID, source fields, and optional relevance score. ### Incidents - **Search, create, and update incidents:** Manage incidents in Grafana Incident, including searching, creating, and adding activities to incidents. ### Sift Investigations - **List Sift investigations:** Retrieve a list of Sift investigations, with support for a limit parameter. - **Get Sift investigation:** Retrieve details of a specific Sift investigation by its UUID. - **Get Sift analyses:** Retrieve a specific analysis from a Sift investigation. - **Find error patterns in logs:** Detect elevated error patterns in Loki logs using Sift. - **Find slow requests:** Detect slow requests using Sift (Tempo). ### Alerting - **List and fetch alert rule information:** View alert rules and their statuses (firing/normal/error/etc.) in Grafana. Supports both Grafana-managed rules and datasource-managed rules from Prometheus or Loki datasources. - **Create and update alert rules:** Create new alert rules or modify existing ones. - **Delete alert rules:** Remove alert rules by UID. - **Manage alerting routing:** View notification policies, contact points, and time intervals. Supports both Grafana-managed contact points and receivers from external Alertmanager datasources (Prometheus Alertmanager, Mimir, Cortex). ### Grafana OnCall - **List and manage schedules:** View and manage on-call schedules in Grafana OnCall. - **Get shift details:** Retrieve detailed information about specific on-call shifts. - **Get current on-call users:** See which users are currently on call for a schedule. - **List teams and users:** View all OnCall teams and users. - **List alert groups:** View and filter alert groups from Grafana OnCall by various criteria including state, integration, labels, and time range. - **Get alert group details:** Retrieve detailed information about a specific alert group by its ID. ### Admin > **Note:** Admin tools are **disabled by default**. To enable them, include `admin` in your `--enabled-tools` flag. - **List teams:** View all configured teams in Grafana. - **List Users:** View all users in an organization in Grafana. - **List all roles:** List all Grafana roles, with an optional filter for delegatable roles. - **Get role details:** Get details for a specific Grafana role by UID. - **List assignments for a role:** List all users, teams, and service accounts assigned to a role. - **List roles for users:** List all roles assigned to one or more users. - **List roles for teams:** List all roles assigned to one or more teams. - **List permissions for a resource:** List all permissions defined for a specific resource (dashboard, datasource, folder, etc.). - **Describe a Grafana resource:** List available permissions and assignment capabilities for a resource type. ### Navigation - **Generate deeplinks:** Create accurate deeplink URLs for Grafana resources instead of relying on LLM URL guessing. - **Dashboard links:** Generate direct links to dashboards using their UID (e.g., `http://localhost:3000/d/dashboard-uid`) - **Panel links:** Create links to specific panels within dashboards with viewPanel parameter (e.g., `http://localhost:3000/d/dashboard-uid?viewPanel=5`) - **Explore links:** Generate links to Grafana Explore with pre-configured datasources (e.g., `http://localhost:3000/explore?left={"datasource":"prometheus-uid"}`) - **Time range support:** Add time range parameters to links (`from=now-1h&to=now`) - **Custom parameters:** Include additional query parameters like dashboard variables or refresh intervals ### Annotations - **Get Annotations:** Query annotations with filters. Supports time range, dashboard UID, tags, and match mode. - **Create Annotation:** Create a new annotation on a dashboard or panel. - **Create Graphite Annotation:** Create annotations using Graphite format (`what`, `when`, `tags`, `data`). - **Update Annotation:** Replace all fields of an existing annotation (full update). - **Patch Annotation:** Update only specific fields of an annotation (partial update). - **Get Annotation Tags:** List available annotation tags with optional filtering. ### Snapshots - **List snapshots:** List dashboard snapshots with optional query and limit filters. - **Get snapshot:** Retrieve snapshot metadata and dashboard payload by snapshot key. - **Create snapshot:** Create a dashboard snapshot from a full dashboard payload, with optional expiration and external snapshot options. - **Delete snapshot:** Delete a snapshot by snapshot key. ### Rendering - **Get panel or dashboard image:** Render a Grafana dashboard panel or full dashboard as a PNG image. Returns the image as base64 encoded data for use in reports, alerts, or presentations. Supports customizing dimensions, time range, theme, scale, and dashboard variables. Also supports rendering not-yet-applied dashboards from a provisioning repository branch (e.g. a git-sync PR preview) via the optional `provisioningPreview` parameter. - _Note: Requires the [Grafana Image Renderer](https://grafana.com/docs/grafana/latest/setup-grafana/image-rendering/) service to be installed and configured._ ### Provisioning - **List provisioning repositories:** List provisioning repositories configured for this Grafana instance (e.g. git-sync sources), returning each repository's slug along with its source URL, branch, path, sync state, and health. - **Validate provisioning file:** Dry-run-apply a file from a provisioning repository at a given branch or commit. Returns whether it would be accepted, the resource action (create/update), the target resource type, and any structured validation errors — the same admission surface Grafana's PR commenter uses. 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. To disable a category of tools, use the `--disable-<category>` flag when starting the server. For example, to disable the OnCall tools, use `--disable-oncall`, or to disable navigation deeplink generation, use `--disable-navigation`. #### RBAC Permissions Each tool requires specific RBAC permissions to function properly. When creating a service account for the MCP server, ensure it has the necessary permissions based on which tools you plan to use. The permissions listed are the minimum required actions - you may also need appropriate scopes (e.g., `datasources:*`, `dashboards:*`, `folders:*`) depending on your use case. Tip: If you're not familiar with Grafana RBAC or you want a quicker, simpler setup instead of configuring many granular scopes, you can assign a built-in role such as `Editor` to the service account. The `Editor` role grants broad read/write access that will allow most MCP server operations; it is less granular (and therefore less restrictive) than manually-applied scopes, so use it only when convenience is more important than strict least-privilege access. **Note:** Grafana Incident and Sift tools use basic Grafana roles instead of fine-grained RBAC permissions: - **Viewer role:** Required for read-only operations (list incidents, get investigations) - **Editor role:** Required for write operations (create incidents, modify investigations) For more information about Grafana RBAC, see the [official documentation](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/). #### RBAC Scopes Scopes define the specific resources that permissions apply to. Each action requires both the appropriate permission and scope combination. **Common Scope Patterns:** - **Broad access:** Use `*` wildcards for organization-wide access - `datasources:*` - Access to all datasources - `dashboards:*` - Access to all dashboards - `folders:*` - Access to all folders - `teams:*` - Access to all teams - **Limited access:** Use specific UIDs or IDs to restrict access to individual resources - `datasources:uid:prometheus-uid` - Access only to a specific Prometheus datasource - `dashboards:uid:abc123` - Access only to dashboard with UID `abc123` - `folders:uid:xyz789` - Access only to folder with UID `xyz789` - `teams:id:5` - Access only to team with ID `5` - `global.users:id:123` - Access only to user with ID `123` **Examples:** - **Full MCP server access:** Grant broad permissions for all tools ``` datasources:* (datasources:read, datasources:query) dashboards:* (dashboards:read, dashboards:create, dashboards:write) folders:* (for dashboard creation and alert rules) teams:* (teams:read) global.users:* (users:read) ``` - **Limited datasource access:** Only query specific Prometheus and Loki instances ``` datasources:uid:prometheus-prod (datasources:query) datasources:uid:loki-prod (datasources:query) ``` - **Dashboard-specific access:** Read only specific dashboards ``` dashboards:uid:monitoring-dashboard (dashboards:read) dashboards:uid:alerts-dashboard (dashboards:read) ``` ### Tools | Tool | Category | Description | Required RBAC Permissions | Required Scopes | | --------------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | --------------------------------------------------- | | `list_teams` | Admin | List all teams | `teams:read` | `teams:*` or `teams:id:1` | | `list_users_by_org` | Admin | List all users in an organization | `users:read` | `global.users:*` or `global.users:id:123` | | `list_all_roles` | Admin | List all Grafana roles | `roles:read` | `roles:*` | | `get_role_details` | Admin | Get details for a Grafana role | `roles:read` | `roles:uid:editor` | | `get_role_assignments` | Admin | List assignments for a role | `roles:read` | `roles:uid:editor` | | `list_user_roles` | Admin | List roles for users | `roles:read` | `global.users:id:123` | | `list_team_roles` | Admin | List roles for teams | `roles:read` | `teams:id:7` | | `get_resource_permissions` | Admin | List permissions for a resource | `permissions:read` | `dashboards:uid:abcd1234` | | `get_resource_description` | Admin | Describe a Grafana resource type | `permissions:read` | `dashboards:*` | | `search_dashboards` | Search | Search for dashboards | `dashboards:read` | `dashboards:*` or `dashboards:uid:abc123` | | `get_dashboard_by_uid` | Dashboard | Get a dashboard by uid | `dashboards:read` | `dashboards:uid:abc123` | | `update_dashboard` | Dashboard | Update or create a new dashboard | `dashboards:create`, `dashboards:write` | `dashboards:*`, `folders:*` or `folders:uid:xyz789` | | `get_dashboard_panel_queries` | Dashboard | Get panel title, queries, datasource UID and type from a dashboard | `dashboards:read` | `dashboards:uid:abc123` | | `run_panel_query` | RunPanelQuery* | Execute one or more dashboard panel queries | `dashboards:read`, `datasources:query` | `dashboards:uid:*`, `datasources:uid:*` | | `get_dashboard_property` | Dashboard | Extract specific parts of a dashboard using JSONPath expressions | `dashboards:read` | `dashboards:uid:abc123` | | `get_dashboard_summary` | Dashboard | Get a compact summary of a dashboard without full JSON | `dashboards:read` | `dashboards:uid:abc123` | | `list_datasources` | Datasources | List datasources | `datasources:read` | `datasources:*` | | `get_datasource` | Datasources | Get a datasource by UID or name | `datasources:read` | `datasources:uid:prometheus-uid` | | `get_query_examples` | Examples* | Get example queries for a datasource type | `datasources:read` | `datasources:*` | | `query_prometheus` | Prometheus | Execute a query against a Prometheus datasource | `datasources:query` | `datasources:uid:prometheus-uid` | | `list_prometheus_metric_metadata` | Prometheus | List metric metadata | `datasources:query` | `datasources:uid:prometheus-uid` | | `list_prometheus_metric_names` | Prometheus | List available metric names | `datasources:query` | `datasources:uid:prometheus-uid` | | `list_prometheus_label_names` | Prometheus | List label names matching a selector | `datasources:query` | `datasources:uid:prometheus-uid` | | `list_prometheus_label_values` | Prometheus | List values for a specific label | `datasources:query` | `datasources:uid:prometheus-uid` | | `query_prometheus_histogram` | Prometheus | Calculate histogram percentile values | `datasources:query` | `datasources:uid:prometheus-uid` | | `list_incidents` | Incident | List incidents in Grafana Incident | Viewer role | N/A | | `create_incident` | Incident | Create an incident in Grafana Incident | Editor role | N/A | | `add_activity_to_incident` | Incident | Add an activity item to an incident in Grafana Incident | Editor role | N/A | | `get_incident` | Incident | Get a single incident by ID | Viewer role | N/A | | `query_loki_logs` | Loki | Query and retrieve logs using LogQL (either log or metric queries) | `datasources:query` | `datasources:uid:loki-uid` | | `list_loki_label_names` | Loki | List all available label names in logs | `datasources:query` | `datasources:uid:loki-uid` | | `list_loki_label_values` | Loki | List values for a specific log label | `datasources:query` | `datasources:uid:loki-uid` | | `query_loki_stats` | Loki | Get statistics about log streams | `datasources:query` | `datasources:uid:loki-uid` | | `query_loki_patterns` | Loki | Query detected log patterns to identify common structures | `datasources:query` | `datasources:uid:loki-uid` | | `analyze_loki_labels` | Loki | Audit a Loki label strategy (live or static) and optionally diagnose query performance | `datasources:query` | `datasources:uid:loki-uid` | | `suggest_loki_alloy_label_config` | Config | Generate an Alloy `loki.process` snippet enforcing approved labels | N/A | N/A | | `query_influxdb` | InfluxDB | Query InfluxDB using InfluxQL (v1) or Flux (v2) | `datasources:query` | `datasources:uid:influxdb-uid` | | `list_clickhouse_tables` | ClickHouse* | List tables in a ClickHouse database | `datasources:query` | `datasources:uid:*` | | `describe_clickhouse_table` | ClickHouse* | Get table schema with column types | `datasources:query` | `datasources:uid:*` | | `query_clickhouse` | ClickHouse* | Execute SQL queries with macro substitution | `datasources:query` | `datasources:uid:*` | | `list_cloudwatch_namespaces` | CloudWatch* | List ava
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.