{"id":8749,"library":"uipath-mcp","title":"UiPath MCP SDK","description":"The UiPath MCP (Managed Cloud Platform) SDK for Python enables developers to build custom activities that integrate with the UiPath ecosystem. It provides the necessary interfaces and tools for creating and exposing automations as discoverable services within UiPath Orchestrator. The current version is 0.2.2, with releases typically aligned with the core `uipath` Python SDK.","status":"active","version":"0.2.2","language":"en","source_language":"en","source_url":"https://github.com/UiPath/uipath-mcp-python","tags":["uipath","rpa","automation","sdk","mcp","orchestrator"],"install":[{"cmd":"pip install uipath-mcp","lang":"bash","label":"Install latest version"}],"dependencies":[{"reason":"Core UiPath Python SDK, required for runtime communication and protocols.","package":"uipath","optional":false},{"reason":"Provides the runtime interface and base classes for MCP services.","package":"uipath-runtime","optional":false}],"imports":[{"symbol":"UiPathMCP","correct":"from uipath_mcp.mcp import UiPathMCP"},{"symbol":"GetHealthResponse, ProcessRequest","correct":"from uipath_mcp.models import GetHealthResponse, ProcessRequest"}],"quickstart":{"code":"import os\nfrom uipath_mcp.mcp import UiPathMCP\nfrom uipath_mcp.models import GetHealthResponse, ProcessRequest\n\nclass MyMCP(UiPathMCP):\n    async def GetHealth(self) -> GetHealthResponse:\n        print(\"Health check requested.\")\n        return GetHealthResponse(status=\"HEALTHY\")\n\n    async def Process(self, request: ProcessRequest) -> None:\n        print(f\"Received process request: {request.input}\")\n        # Implement your automation logic here based on request.input\n        # For example, calling another UiPath process or external API\n\n# Ensure these environment variables are set for authentication and server URL\n# UIPATH_MCP_CLIENT_ID, UIPATH_MCP_CLIENT_SECRET, UIPATH_MCP_SERVER_URL\nif __name__ == \"__main__\":\n    # Basic check for required env vars for quickstart to avoid immediate failure\n    if not all(os.environ.get(var) for var in ['UIPATH_MCP_CLIENT_ID', 'UIPATH_MCP_CLIENT_SECRET', 'UIPATH_MCP_SERVER_URL']):\n        print(\"Warning: Please set UIPATH_MCP_CLIENT_ID, UIPATH_MCP_CLIENT_SECRET, UIPATH_MCP_SERVER_URL environment variables to run this example.\")\n        print(\"Example: export UIPATH_MCP_CLIENT_ID='your_client_id'\")\n    try:\n        mcp = MyMCP()\n        mcp.run() # This will start the server and listen for requests\n    except Exception as e:\n        print(f\"An error occurred: {e}\")\n        print(\"Ensure all required environment variables are set and dependencies are correct.\")\n","lang":"python","description":"This quickstart defines a simple UiPath MCP service by inheriting from `UiPathMCP` and implementing the `GetHealth` and `Process` methods. The `Process` method is where your custom automation logic resides. To run this, you need to set specific environment variables for authentication with UiPath Orchestrator."},"warnings":[{"fix":"Ensure your `uipath` and `uipath-runtime` packages are at or above the specified minimum versions: `pip install --upgrade uipath uipath-runtime`.","message":"Version 0.2.0 introduced breaking changes by bumping minimum dependency versions for `uipath` to `>=2.10.40` and `uipath-runtime` to `>=0.10.0`. Projects using older versions of these dependencies will fail until upgraded.","severity":"breaking","affected_versions":">=0.2.0"},{"fix":"Review the `uipath-mcp-python` GitHub README and examples for the `UiPathRuntimeProtocol` and `UiPathRuntimeFactoryProtocol` usage patterns, and refactor your MCP service accordingly.","message":"Version 0.1.0 aligned with UiPath Python SDK v2.2.0, adopting a new `UiPathRuntimeProtocol` pattern and replacing the previous middleware-based approach. Existing MCP implementations built with pre-0.1.0 versions will require refactoring to conform to the new protocol.","severity":"breaking","affected_versions":">=0.1.0"},{"fix":"Before running your MCP service, set the required environment variables: `export UIPATH_MCP_CLIENT_ID='...'`, `export UIPATH_MCP_CLIENT_SECRET='...'`, `export UIPATH_MCP_SERVER_URL='https://cloud.uipath.com/your_org_name/your_tenant_name/'`.","message":"The `uipath-mcp` service requires specific environment variables (`UIPATH_MCP_CLIENT_ID`, `UIPATH_MCP_CLIENT_SECRET`, `UIPATH_MCP_SERVER_URL`) to be set for authentication and to locate the UiPath Orchestrator endpoint. Missing these will prevent the service from starting or connecting.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-04-16T00:00:00.000Z","next_check":"2026-07-15T00:00:00.000Z","problems":[{"fix":"Run `pip install uipath-mcp` to install the library.","cause":"The `uipath-mcp` package is not installed in the current Python environment.","error":"ModuleNotFoundError: No module named 'uipath_mcp'"},{"fix":"Set the necessary environment variables before running your application: `export UIPATH_MCP_CLIENT_ID='your_id'`, `export UIPATH_MCP_CLIENT_SECRET='your_secret'`, `export UIPATH_MCP_SERVER_URL='your_orchestrator_url'`.","cause":"The `uipath-mcp` SDK requires specific environment variables for authentication and endpoint configuration, which were not found.","error":"RuntimeError: Missing environment variable: UIPATH_MCP_CLIENT_ID (or similar for CLIENT_SECRET, SERVER_URL)"},{"fix":"First, ensure all dependencies are up-to-date: `pip install --upgrade uipath-mcp uipath uipath-runtime`. If the issue persists, review the breaking changes for `uipath-mcp` v0.1.0 and v0.2.0, and update your code to match the current `UiPathRuntimeProtocol` pattern as shown in the quickstart.","cause":"This often indicates a mismatch between your `uipath-mcp` version and its core dependencies (`uipath`, `uipath-runtime`), or that your MCP service is built on an outdated architectural pattern (e.g., pre-0.1.0 middleware pattern).","error":"AttributeError: 'YourOldClass' object has no attribute 'run' (or similar errors related to internal UiPath SDK components)"}]}