iflow-mcp_drdroidlab-grafana-mcp-server 0.1.0__py3-none-any.whl

grafana_mcp_server/stdio_server.py

@@ -0,0 +1,36 @@
+import json
+import sys
+from time import sleep
+
+
+def run_stdio_server(handler):
+    """
+    Reads JSON-RPC requests from stdin, calls the handler, and writes responses to stdout.
+    The handler should be a function that takes a dict and returns a dict (the response).
+    """
+    while True:
+        line = sys.stdin.readline()
+        if not line:
+            print("No line read", file=sys.stderr)
+            sleep(1)
+            continue
+        line = line.strip()
+        if not line:
+            continue
+        try:
+            data = json.loads(line)
+            response = handler(data)
+            sys.stdout.write(json.dumps(response) + "\n")
+            sys.stdout.flush()
+        except Exception as e:
+            sys.stdout.write(
+                json.dumps(
+                    {
+                        "jsonrpc": "2.0",
+                        "error": {"code": -32000, "message": str(e)},
+                        "id": None,
+                    }
+                )
+                + "\n"
+            )
+            sys.stdout.flush()

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/METADATA

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: iflow-mcp_drdroidlab-grafana-mcp-server
+Version: 0.1.0
+Summary: MCP Server for Grafana API integration - enables AI assistants to query Grafana dashboards, datasources, and metrics
+Project-URL: Homepage, https://github.com/yourusername/grafana-mcp-server
+Project-URL: Documentation, https://github.com/yourusername/grafana-mcp-server#readme
+Project-URL: Repository, https://github.com/yourusername/grafana-mcp-server
+Project-URL: Issues, https://github.com/yourusername/grafana-mcp-server/issues
+Author-email: Your Name <your.email@example.com>
+License: MIT License
+        
+        Copyright (c) 2025 Doctor Droid
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: ai,claude,cursor,grafana,mcp,monitoring,observability
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.11
+Requires-Dist: flaky
+Requires-Dist: flask==3.0.0
+Requires-Dist: pytest>=8.4.1
+Requires-Dist: python-dateutil>=2.9.0.post0
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: requests>=2.31.0
+Requires-Dist: ruff>=0.12.3
+Requires-Dist: typing-extensions
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Provides-Extra: prod
+Requires-Dist: gunicorn; extra == 'prod'
+Description-Content-Type: text/markdown
+
+# Grafana MCP Server
+
+## Available Tools
+
+The following tools are available via the MCP server:
+
+- **test_connection**: Verify connectivity to your Grafana instance and configuration.
+- **grafana_promql_query**: Execute PromQL queries against Grafana's Prometheus datasource. Fetches metrics data using PromQL expressions, optimizes time series responses to reduce token size.
+- **grafana_loki_query**: Query Grafana Loki for log data. Fetches logs for a specified duration (e.g., '5m', '1h', '2d'), converts relative time to absolute timestamps.
+- **grafana_get_dashboard_config**: Retrieves dashboard configuration details from the database. Queries the connectors_connectormetadatamodelstore table for dashboard metadata.
+- **grafana_query_dashboard_panels**: Execute queries for specific dashboard panels. Can query up to 4 panels at once, supports template variables, optimizes metrics data.
+- **grafana_fetch_label_values**: Fetch label values for dashboard variables from Prometheus datasource. Retrieves available values for specific labels (e.g., 'instance', 'job'). Supports optional metric filtering.
+- **grafana_fetch_dashboard_variables**: Fetch all variables and their values from a Grafana dashboard. Retrieves dashboard template variables and their current values.
+- **grafana_fetch_all_dashboards**: Fetch all dashboards from Grafana with basic information like title, UID, folder, tags, etc.
+- **grafana_fetch_datasources**: Fetch all datasources from Grafana with their configuration details.
+- **grafana_fetch_folders**: Fetch all folders from Grafana with their metadata and permissions.
+
+## 🚀 Usage & Requirements
+
+### 1. Get Your Grafana API Endpoint & Service Account Token
+
+1. Ensure you have a running Grafana instance (self-hosted or cloud).
+2. Generate a Service Account Token from your Grafana UI:
+   - Create Service Account: In your Grafana dashboard, navigate to Admin >> Users & Access >> Service Accounts >> Create a Service Account with Viewer permissions
+   - Generate Service Account Key: Within Service Account, create a new Service Account token.
+   - Copy the service account token (starts with `glsa_`)
+
+---
+
+## 2. Installation & Running Options
+
+### 2A. Install & Run with uv (Recommended for Local Development)
+
+#### 2A.1. Install dependencies with uv
+
+```bash
+uv venv .venv
+source .venv/bin/activate
+uv sync
+```
+
+#### 2A.2. Run the server with uv
+
+```bash
+uv run -m src.grafana_mcp_server.mcp_server
+```
+
+- You can also use `uv` to run any other entrypoint scripts as needed.
+- Make sure your `config.yaml` is in the same directory as `mcp_server.py` or set the required environment variables (see Configuration section).
+
+---
+
+### 2B. Run with Docker Compose (Recommended for Production/Containerized Environments)
+
+1. Edit `grafana-mcp-server/src/grafana_mcp_server/config.yaml` with your Grafana details (host, API key).
+2. Start the server:
+   ```bash
+   docker compose up -d
+   ```
+   - The server will run in HTTP (SSE) mode on port 8000 by default.
+   - You can override configuration with environment variables (see below).
+
+---
+
+## 3. Configuration
+
+The server loads configuration in the following order of precedence:
+
+1. **Environment Variables** (recommended for Docker/CI):
+   - `GRAFANA_HOST`: Grafana instance URL (e.g. `https://your-grafana-instance.com`)
+   - `GRAFANA_API_KEY`: Grafana Service Account Token (required)
+   - `GRAFANA_SSL_VERIFY`: `true` or `false` (default: `true`)
+   - `MCP_SERVER_PORT`: Port to run the server on (default: `8000`)
+   - `MCP_SERVER_DEBUG`: `true` or `false` (default: `true`)
+2. **YAML file fallback** (`config.yaml`):
+   ```yaml
+   grafana:
+     host: "https://your-grafana-instance.com"
+     api_key: "your-grafana-api-key-here"
+     ssl_verify: "true"
+   server:
+     port: 8000
+     debug: true
+   ```
+
+---
+
+## 4. Integration with AI Assistants (e.g., Claude Desktop, Cursor)
+
+You can integrate this MCP server with any tool that supports the MCP protocol. Here are the main options:
+
+### 4A. Using Docker (with environment variables)
+
+```json
+{
+  "mcpServers": {
+    "grafana": {
+      "command": "docker",
+      "args": [
+        "run",
+        "--rm",
+        "-i",
+        "-e",
+        "GRAFANA_HOST",
+        "-e",
+        "GRAFANA_API_KEY",
+        "-e",
+        "GRAFANA_SSL_VERIFY",
+        "drdroidlab/grafana-mcp-server",
+        "-t",
+        "stdio"
+      ],
+      "env": {
+        "GRAFANA_HOST": "https://your-grafana-instance.com",
+        "GRAFANA_API_KEY": "your-grafana-api-key-here",
+        "GRAFANA_SSL_VERIFY": "true"
+      }
+    }
+  }
+}
+```
+
+- The `-t stdio` argument is supported for compatibility with Docker MCP clients (forces stdio handshake mode).
+- Adjust the volume path or environment variables as needed for your deployment.
+
+### 4B. Connecting to an Already Running MCP Server (HTTP/SSE)
+
+If you have an MCP server already running (e.g., on a remote host, cloud VM, or Kubernetes), you can connect your AI assistant or tool directly to its HTTP endpoint.
+
+```json
+{
+  "mcpServers": {
+    "grafana": {
+      "url": "http://your-server-host:8000/mcp"
+    }
+  }
+}
+```
+
+- Replace `your-server-host` with the actual host where your MCP server is running.
+- **For local setup, use `localhost` as the server host (i.e., `http://localhost:8000/mcp`).**
+- **Use `http` for local or unsecured deployments, and `https` for production or secured deployments.**
+- Make sure the server is accessible from your client machine (check firewall, security group, etc.).
+
+---
+
+## Health Check
+
+```bash
+curl http://localhost:8000/health
+```
+
+The server runs on port 8000 by default.
+
+---
+
+## 5. Project Structure
+
+```
+grafana-mcp-server/
+│   └── src/
+│       └── grafana_mcp_server/
+│           ├── __init__.py
+│           ├── config.yaml              # Configuration file
+│           ├── mcp_server.py            # Main MCP server implementation
+│           ├── stdio_server.py          # STDIO server for MCP
+│           └── processor/
+│               ├── __init__.py
+│               ├── grafana_processor.py # Grafana API processor
+│               └── processor.py         # Base processor interface
+├── tests/
+├── Dockerfile
+├── docker-compose.yml
+├── pyproject.toml
+└── README.md
+```
+
+---
+
+---
+
+## 6. Troubleshooting
+
+### Common Issues
+
+1. **Connection Failed**:
+
+   - Verify your Grafana instance is running and accessible
+   - Check your API key has proper permissions
+   - Ensure SSL verification settings match your setup
+
+2. **Authentication Errors**:
+
+   - Verify your API key is correct and not expired
+   - Check if your Grafana instance requires additional authentication
+
+3. **Query Failures**:
+   - Ensure datasource UIDs are correct
+   - Verify PromQL/Loki query syntax
+   - Check if the datasource is accessible with your API key
+
+### Debug Mode
+
+Enable debug mode to get more detailed logs:
+
+```bash
+export MCP_SERVER_DEBUG=true
+```
+
+---
+
+## 7. Contributing
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+---
+
+## 8. License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+## 9. Support
+
+1. Need help anywhere? Join our [discord channel](https://discord.gg/GTzfNMSm) and message on #mcp channel.
+2. Want a 1-click MCP Server? Join the same community and let us know.
+3. For issues and questions, please open an issue on GitHub or contact the maintainers.

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+grafana_mcp_server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+grafana_mcp_server/config.yaml,sha256=_3atvreP7JjPCGxeHA0TcC0D6aBbYDol0w63ffwMUMQ,328
+grafana_mcp_server/mcp_server.py,sha256=x8S-BFKjFaqL2V2xDTOr88M88vJgDxBF93exKYZRo5w,24061
+grafana_mcp_server/stdio_server.py,sha256=tSuTC0tc_17FHTan43MSp7SuNRyg3vLIoyfXNaahkjY,1054
+grafana_mcp_server/processor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+grafana_mcp_server/processor/grafana_processor.py,sha256=p0X763gvgFs3iMnuOev_2Sb_C__ysmbJFpi5yhcHRV8,31128
+grafana_mcp_server/processor/processor.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/METADATA,sha256=nZYhW8Ch5V1kjTcBnrHU75Xj5H2Tly0pTzO2EvqXJ6g,10530
+iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/entry_points.txt,sha256=QEuMtd0vnzBw9u2OlbrLtMEgDD1cjjLiznlg8MsG6Ik,78
+iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/licenses/LICENSE,sha256=v6DSvYihESAcIL8D-f5hYXu05--UCvk7ack7ozumkWU,1069
+iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/RECORD,,

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+grafana-mcp-server = src.grafana_mcp_server.mcp_server:main

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Doctor Droid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.