Add Docker support and Anthropic MCP registry preparation (#13)

strickvl · web-flow · commit e98d836accb0 · 2025-09-09T19:49:02.000+02:00
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,34 @@
+# VCS/IDE
+.git
+.gitignore
+.cursor
+.vscode
+.DS_Store
+
+# CI and docs
+.github
+assets
+design
+
+# Python artifacts
+__pycache__
+*.pyc
+*.pyo
+*.pyd
+*.log
+*.egg-info
+dist
+build
+.cache
+.venv
+venv
+env
+
+# Desktop extension bundle
+*.dxt
+
+# MCP registry metadata (if added later)
+.mcp
+
+# Vendored libs (we install via pip inside the image)
+server/lib/
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml
@@ -0,0 +1,63 @@
+name: Docker Publish
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+env:
+  IMAGE_NAME: docker.io/zenmldocker/mcp-zenml
+
+permissions:
+  contents: read
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    concurrency:
+      group: docker-publish-${{ github.ref }}
+      cancel-in-progress: true
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels)
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=sha,format=short,prefix=sha-
+          labels: |
+            org.opencontainers.image.title=ZenML MCP Server
+            org.opencontainers.image.description=Model Context Protocol server for ZenML
+            org.opencontainers.image.source=https://github.com/${{ github.repository }}
+            org.opencontainers.image.licenses=MIT
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Image digest
+        run: echo "Digest -> ${{ steps.meta.outputs.digest }}"
diff --git a/.github/workflows/release-docker.yml b/.github/workflows/release-docker.yml
@@ -0,0 +1,56 @@
+name: Release Docker
+
+on:
+  push:
+    tags: ["v*.*.*"]
+
+env:
+  IMAGE_NAME: docker.io/zenmldocker/mcp-zenml
+
+permissions:
+  contents: read
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels)
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=raw,value=latest
+          labels: |
+            org.opencontainers.image.title=ZenML MCP Server
+            org.opencontainers.image.description=Model Context Protocol server for ZenML
+            org.opencontainers.image.source=https://github.com/${{ github.repository }}
+            org.opencontainers.image.licenses=MIT
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
diff --git a/.gitignore b/.gitignore
@@ -176,3 +176,4 @@ cython_debug/
 # project-specific ignores
 design/
 mcp.json
+.claude/
diff --git a/AGENTS.md b/AGENTS.md
@@ -0,0 +1,34 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- `server/` – MCP server implementation. Main entry: `server/zenml_server.py`; treat `server/lib/` as vendored support code (avoid edits unless necessary).
+- `scripts/` – Developer utilities: `format.sh` (ruff) and `test_mcp_server.py` (smoke test).
+- `assets/` – Images and static assets.
+- Root files – `README.md`, `manifest.json`, `mcp-zenml.dxt` (DXT package), CI in `.github/workflows/`.
+
+## Build, Test, and Development Commands
+- Run server locally: `uv run server/zenml_server.py`
+- Smoke test (local): `uv run scripts/test_mcp_server.py server/zenml_server.py`
+- Format & lint: `bash scripts/format.sh` (ruff check + import sort + format)
+- CI mirrors the smoke test via GitHub Actions and requires Python 3.12.
+
+## Coding Style & Naming Conventions
+- Language: Python 3.12+. Indentation: 4 spaces.
+- Use snake_case for functions/variables, PascalCase for classes, UPPER_SNAKE_CASE for constants.
+- Keep imports tidy; `scripts/format.sh` enforces ruff rules and import sorting.
+- Logging: prefer `logging` to stderr; avoid printing from MCP tool functions except returning strings/JSON. Keep logs minimal to avoid MCP JSON protocol interference.
+
+## Testing Guidelines
+- Primary test: `scripts/test_mcp_server.py` exercises MCP connection, initialization, and basic tools.
+- Run locally with `uv run ...`; CI runs on PRs and a scheduled workflow.
+- If adding tests, follow descriptive names (e.g., `test_<area>_behavior.py`) and place alongside existing script tests under `scripts/` or add a `tests/` folder. Keep tests fast and network-light; mock ZenML calls when feasible.
+
+## Commit & Pull Request Guidelines
+- Commits: concise, imperative subject (e.g., "Update README", "Add smoke test"), group related changes.
+- PRs: include a clear description, link related issues, and add logs/screenshots for failures or tool output when relevant. Ensure CI passes (smoke test and formatting).
+
+## Security & Configuration Tips
+- Required env vars to run tools: `ZENML_STORE_URL`, `ZENML_STORE_API_KEY`.
+- Prefer `uv` for isolated runs. Do not log secrets; scrub values in examples and CI output.
+- Avoid modifying `server/lib/` unless you understand downstream effects.
+
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,38 @@
+# syntax=docker/dockerfile:1
+FROM python:3.12-slim AS base
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PYTHONIOENCODING=UTF-8 \
+    PIP_NO_CACHE_DIR=1 \
+    LOGLEVEL=WARNING \
+    NO_COLOR=1 \
+    ZENML_LOGGING_COLORS_DISABLED=true \
+    ZENML_ENABLE_RICH_TRACEBACK=false
+
+# Optional but helpful: fresh CA certs for TLS reliability
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends ca-certificates \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /app
+
+# Install Python dependencies
+COPY requirements.txt /app/
+RUN pip install --upgrade pip setuptools wheel \
+    && pip install -r requirements.txt
+
+# Security: non-root user
+RUN useradd -m -u 10001 appuser
+USER appuser
+
+# Copy only what we need to run the server in stdio mode
+COPY --chown=appuser:appuser server/zenml_server.py /app/server/zenml_server.py
+
+# OCI labels (will be enriched/overridden by CI metadata)
+LABEL org.opencontainers.image.title="ZenML MCP Server" \
+      org.opencontainers.image.description="Model Context Protocol server for ZenML" \
+      org.opencontainers.image.source="https://github.com/zenml-io/mcp-zenml" \
+      org.opencontainers.image.licenses="MIT"
+
+ENTRYPOINT ["python", "-u", "server/zenml_server.py"]
diff --git a/README.md b/README.md
@@ -104,8 +104,11 @@ You will need to specify your ZenML MCP server in the following format:
             "command": "/usr/local/bin/uv",
             "args": ["run", "path/to/server/zenml_server.py"],
             "env": {
-                "LOGLEVEL": "INFO",
+                "LOGLEVEL": "WARNING",
                 "NO_COLOR": "1",
+                "ZENML_LOGGING_COLORS_DISABLED": "true",
+                "ZENML_LOGGING_VERBOSITY": "WARN",
+                "ZENML_ENABLE_RICH_TRACEBACK": "false",
                 "PYTHONUNBUFFERED": "1",
                 "PYTHONIOENCODING": "UTF-8",
                 "ZENML_STORE_URL": "https://your-zenml-server-goes-here.com",
@@ -178,6 +181,50 @@ In our experience, sometimes it shows a red error indicator even though it is
 working. You can try it out by chatting in the Cursor chat window. It will let
 you know if is able to access the ZenML tools or not.
 
+## Docker Image
+
+You can run the server as a Docker container. The process communicates over stdio, so it will wait for an MCP client connection. Pass your ZenML credentials via environment variables.
+
+### Prebuilt Images (Docker Hub)
+
+Pull the latest multi-arch image:
+
+```bash
+docker pull zenmldocker/mcp-zenml:latest
+```
+
+Versioned releases are tagged as `vX.Y.Z`:
+
+```bash
+docker pull zenmldocker/mcp-zenml:v1.0.0
+```
+
+Run with your ZenML credentials (stdio mode):
+
+```bash
+docker run -i --rm \
+  -e ZENML_STORE_URL="https://your-zenml-server.example.com" \
+  -e ZENML_STORE_API_KEY="your-api-key" \
+  zenmldocker/mcp-zenml:latest
+```
+
+### Build Locally
+
+From the repository root:
+
+```bash
+docker build -t zenmldocker/mcp-zenml:local .
+```
+
+Run the locally built image:
+
+```bash
+docker run -i --rm \
+  -e ZENML_STORE_URL="https://your-zenml-server.example.com" \
+  -e ZENML_STORE_API_KEY="your-api-key" \
+  zenmldocker/mcp-zenml:local
+```
+
 ## Desktop Extensions (DXT) Support
 
 This project supports [Anthropic's Desktop Extensions (DXT) standard](https://www.anthropic.com/engineering/desktop-extensions), which makes installing MCP servers as simple as clicking a button. DXT is a new packaging format that bundles entire MCP servers into a single `.dxt` file, including all dependencies and providing user-friendly configuration.
diff --git a/requirements.txt b/requirements.txt
@@ -2,3 +2,4 @@ httpx
 mcp[cli]
 zenml
 setuptools
+requests>=2.32.0
