iflow-mcp_drdroidlab-grafana-mcp-server 0.1.0__tar.gz

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0/.gitignore

@@ -0,0 +1,340 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be added to the global gitignore or merged into this project gitignore.  For a PyCharm
+#  project, it is recommended to include the following files:
+#  .idea/
+#  *.iml
+#  *.ipr
+#  *.iws
+.idea/
+*.iml
+*.ipr
+*.iws
+
+# VS Code
+.vscode/
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# Linux
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+# Docker
+.dockerignore
+
+# Logs
+*.log
+logs/
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory used by tools like istanbul
+coverage/
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node_modules
+node_modules/
+
+# Optional npm cache directory
+.npm
+.ruff_cache/
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+public
+
+# Storybook build outputs
+.out
+.storybook-out
+storybook-static
+
+# Temporary folders
+tmp/
+temp/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# Local environment files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Lock files (keep uv.lock as it's used for dependency management)
+# uv.lock 

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0/Dockerfile

@@ -0,0 +1,33 @@
+# Dockerfile
+FROM ghcr.io/astral-sh/uv:python3.12-bookworm-slim
+
+# Set working directory
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    curl \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy pyproject.toml for dependency installation
+COPY pyproject.toml .
+
+# Create a basic uv.lock file (since we don't have one yet)
+RUN uv lock
+
+# Install Python dependencies using uv
+RUN uv sync
+
+# Copy application code
+COPY ./src ./src
+
+# Create a non-root user for security
+RUN useradd -m -u 1000 mcp && chown -R mcp:mcp /app
+USER mcp
+
+# Expose the port
+EXPOSE 8000
+
+# Set PYTHONPATH and run as a module
+ENV PYTHONPATH=/app
+ENTRYPOINT ["uv", "run", "-m", "src.grafana_mcp_server.mcp_server"]

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0/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.

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

iflow_mcp_drdroidlab_grafana_mcp_server-0.1.0/PKG-INFO

@@ -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.