Merge pull request #7 from zenml-io/misc/dxt-compatibility

Add DXT Desktop Extension support and improve compatibility

Author: strickvl

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ZenML
+
+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.

README.md

@@ -102,7 +102,7 @@ You will need to specify your ZenML MCP server in the following format:
     "mcpServers": {
         "zenml": {
             "command": "/usr/local/bin/uv",
-            "args": ["run", "path/to/zenml_server.py"],
+            "args": ["run", "path/to/server/zenml_server.py"],
             "env": {
                 "LOGLEVEL": "INFO",
                 "NO_COLOR": "1",
@@ -138,18 +138,11 @@ dependency installation for you.
 
 ### Installation for use with Claude Desktop
 
-You will need to have [Claude Desktop](https://claude.ai/download) installed.
+You will need to have the latest version of [Claude Desktop](https://claude.ai/download) installed.
 
-Once you have installed and opened Claude Desktop, you need to open the
-'Settings' menu and click on the 'Developer' tab. There will be an 'Edit Config'
-button which will open up a file explorer showing you the location of your
-config file.
-
-You should paste the contents of the (properly filled in) config file above into
-the JSON file revealed in the file explorer. Then just restart Claude Desktop
-and it will use the new config. You should be able to see the ZenML server in
-the developer settings menu. Chat with Claude and it will use all the new tools
-you just gave it access to.
+You can simply open the Settings menu and drag the `mcp-zenml.dxt` file from the
+root of this repository on top of the menu and it will guide you through the
+installation and setup process. You'll need to add your ZenML server URL and API key.
 
 #### Optional: Improving ZenML Tool Output Display
 
@@ -184,3 +177,17 @@ To set it up for a single repository, you will need to:
 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.
+
+## 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.
+
+The `mcp-zenml.dxt` file in the repository root contains everything needed to run the ZenML MCP server, eliminating the need for complex manual installation steps. This makes powerful ZenML integrations accessible to users without requiring technical setup expertise.
+
+When you drag and drop the `.dxt` file into Claude Desktop's settings, it automatically handles:
+- Runtime dependency installation
+- Secure configuration management  
+- Cross-platform compatibility
+- User-friendly setup process
+
+For more information about Desktop Extensions and the DXT standard, visit the [official documentation](https://www.anthropic.com/engineering/desktop-extensions).

assets/icon.png

@@ -0,0 +1,87 @@
+{
+  "dxt_version": "0.1",
+  "name": "mcp-zenml",
+  "version": "1.0.0",
+  "description": "MCP server to connect an MCP client with your ZenML MLOps and LLMOps pipelines",
+  "long_description": "The server provides MCP tools to access core read functionality from the ZenML server, delivering live information about users, stacks, pipelines, pipeline runs, pipeline steps, services, stack components, flavors, pipeline run templates, schedules, artifacts (metadata about data artifacts, not the data itself), service connectors, step code, and step logs (if the step was run on a cloud-based stack), while also enabling you to trigger new pipeline runs when a run template is present.",
+  "author": {
+    "name": "ZenML",
+    "email": "[email protected]",
+    "url": "https://zenml.io"
+  },
+  "homepage": "https://zenml.io",
+  "documentation": "https://github.com/zenml-io/mcp-zenml",
+  "support": "https://github.com/zenml-io/mcp-zenml/issues",
+  "icon": "assets/icon.png",
+  "screenshots": [
+    "assets/mcp-zenml.png"
+  ],
+  "server": {
+    "type": "python",
+    "entry_point": "server/zenml_server.py",
+    "mcp_config": {
+      "command": "python3",
+      "args": [
+        "${__dirname}/server/zenml_server.py"
+      ],
+      "env": {
+        "PYTHONPATH": "${__dirname}/server/lib",
+        "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": "${user_config.zenml_store_url}",
+        "ZENML_STORE_API_KEY": "${user_config.zenml_store_api_key}"
+      }
+    }
+  },
+  "user_config": {
+    "zenml_store_url": {
+      "type": "string",
+      "title": "ZenML Server URL",
+      "description": "The URL of your ZenML server (e.g., https://your-server.cloudinfra.zenml.io)",
+      "required": true
+    },
+    "zenml_store_api_key": {
+      "type": "string",
+      "title": "ZenML API Key",
+      "description": "Your ZenML server API key",
+      "required": true,
+      "sensitive": true
+    }
+  },
+  "tools": [
+    {
+      "name": "get_step_logs",
+      "description": "Get the logs for a specific step run"
+    },
+    {
+      "name": "trigger_pipeline",
+      "description": "Trigger a pipeline to run from the server"
+    }
+  ],
+  "prompts": [
+    {
+      "name": "stack_components_analysis",
+      "description": "Analyze the stacks in the ZenML workspace",
+      "text": "Please generate a comprehensive report or dashboard on our ZenML stack components, showing which ones are most frequently used across our pipelines, including information about version compatibility issues and performance variations."
+    },
+    {
+      "name": "recent_runs_analysis",
+      "description": "Analyze the recent runs in the ZenML workspace",
+      "text": "Please generate a comprehensive report or dashboard on our recent runs, showing which pipelines are most frequently run and which ones are most frequently failed. Include information about the status of the runs, the duration, and the stack components used."
+    }
+  ],
+  "keywords": [
+    "mlops",
+    "llmops"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zenml-io/mcp-zenml"
+  }
+}

manifest.json

@@ -1,3 +1,4 @@
 httpx
 mcp[cli]
 zenml
+setuptools

mcp-zenml.dxt

@@ -4,8 +4,16 @@
 #     "httpx",
 #     "mcp[cli]",
 #     "zenml",
+#     "setuptools",
 # ]
 # ///
+
+# Ensure setuptools is imported first to provide distutils compatibility
+try:
+    import setuptools  # noqa
+except ImportError:
+    pass
+
 import functools
 import json
 import logging
@@ -18,15 +26,23 @@
 logger = logging.getLogger(__name__)
 
 # Configure minimal logging to stderr
-log_level_name = os.environ.get("LOGLEVEL", "INFO").upper()
-log_level = getattr(logging, log_level_name, logging.INFO)
+log_level_name = os.environ.get("LOGLEVEL", "WARNING").upper()
+log_level = getattr(logging, log_level_name, logging.WARNING)
 
-# Simple stderr logging configuration
+# Simple stderr logging configuration - explicitly use stderr to avoid JSON protocol issues
 logging.basicConfig(
     level=log_level,
     format="%(levelname)s: %(message)s",
+    stream=sys.stderr,
 )
 
+# Suppress all INFO level logging from all modules to prevent JSON protocol interference
+logging.getLogger().setLevel(logging.WARNING)
+
+# Specifically suppress ZenML's internal logging to prevent JSON protocol issues
+logging.getLogger("zenml").setLevel(logging.WARNING)
+logging.getLogger("zenml.client").setLevel(logging.WARNING)
+
 # Type variable for function return type
 T = TypeVar("T")
 
@@ -723,7 +739,6 @@ def list_pipeline_runs(
     status: str = None,
     start_time: str = None,
     end_time: str = None,
-    num_steps: int = None,
     stack: str = None,
     stack_component: str = None,
 ) -> str:
@@ -743,7 +758,6 @@ def list_pipeline_runs(
         status: The status of the pipeline runs
         start_time: The start time of the pipeline runs
         end_time: The end time of the pipeline runs
-        num_steps: The number of steps in the pipeline runs
         stack: The stack of the pipeline runs
         stack_component: The stack component of the pipeline runs
     """
@@ -761,7 +775,6 @@ def list_pipeline_runs(
         status=status,
         start_time=start_time,
         end_time=end_time,
-        num_steps=num_steps,
         stack=stack,
         stack_component=stack_component,
     )
@@ -1118,8 +1131,6 @@ def most_recent_runs(run_count: int = 10) -> str:
 
 if __name__ == "__main__":
     try:
-        logger.info("Starting MCP server with stdio transport...")
         mcp.run(transport="stdio")
     except Exception as e:
-        logger.error(f"Error running server: {str(e)}")
-        raise
+        logger.error(f"Error running MCP server: {e}")