chore: add ci github actions

Author: radu-mocanu

.github/workflows/publish.yml renamed to .github/workflows/cd.yml

@@ -9,6 +9,9 @@ on:
       - pyproject.toml
 
 jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+
   build:
     name: Build
     runs-on: ubuntu-latest

.github/workflows/cli.yml

@@ -0,0 +1,19 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - pyproject.toml
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  commit-lint:
+    if: ${{ github.event_name == 'pull_request' }}
+    uses: ./.github/workflows/commitlint.yml
+
+  lint:
+    uses: ./.github/workflows/lint.yml

.github/workflows/commitlint.yml

@@ -0,0 +1,47 @@
+name: Commit Lint
+
+on:
+  workflow_call
+
+jobs:
+  commitlint:
+    name: Commit Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 22
+
+      - name: Install Git
+        run: |
+          if ! command -v git &> /dev/null; then
+              echo "Git is not installed. Installing..."
+              sudo apt-get update
+              sudo apt-get install -y git
+          else
+              echo "Git is already installed."
+          fi
+
+      - name: Install commitlint
+        run: |
+          npm install conventional-changelog-conventionalcommits
+          npm install commitlint@latest
+          npm install @commitlint/config-conventional
+
+      - name: Configure
+        run: |
+          echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js
+
+      - name: Validate PR commits with commitlint
+        run: |
+          git fetch origin pull/${{ github.event.pull_request.number }}/head:pr_branch
+          npx commitlint --from ${{ github.event.pull_request.base.sha }} --to pr_branch --verbose

.github/workflows/lint.yml

@@ -0,0 +1,53 @@
+name: Lint
+
+on:
+  workflow_call
+
+jobs:
+  # Job that runs when custom version testing is enabled - just completes successfully
+  skip-lint:
+    name: Skip Lint (Custom Version Testing)
+    runs-on: ubuntu-latest
+    if: contains(github.event.pull_request.labels.*.name, 'test-core-dev-version')
+    permissions:
+      contents: read
+    steps:
+      - name: Skip lint for custom version testing
+        run: |
+          echo "Custom version testing enabled - skipping normal lint process"
+          echo "This job completes successfully to allow PR merging"
+
+  # Job that runs normal lint process when custom version testing is NOT enabled
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.pull_request.labels.*.name, 'test-core-dev-version')"
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Check static types
+        run: uv run mypy --config-file pyproject.toml .
+
+      - name: Check linting
+        run: uv run ruff check .
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+

src/uipath_mcp/_cli/_runtime/_runtime.py

@@ -148,7 +148,7 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
 
             # Set up SignalR client
             uipath_url = os.environ.get("UIPATH_URL")
-            signalr_url = f"{uipath_url}/agenthub_/wsstunnel?slug={self._server.name}&runtimeId={self._runtime_id}"
+            signalr_url = f"{uipath_url}/agenthub_/wsstunnel?slug={self.slug}&runtimeId={self._runtime_id}"
 
             if not self.context.folder_key:
                 folder_path = os.environ.get("UIPATH_FOLDER_PATH")
@@ -159,7 +159,9 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
                         "Please set the UIPATH_FOLDER_PATH or UIPATH_FOLDER_KEY environment variable.",
                         UiPathErrorCategory.USER,
                     )
-                self.context.folder_key = self._uipath.folders.retrieve_key(folder_path=folder_path)
+                self.context.folder_key = self._uipath.folders.retrieve_key(
+                    folder_path=folder_path
+                )
                 if not self.context.folder_key:
                     raise UiPathMcpRuntimeError(
                         "REGISTRATION_ERROR",
@@ -495,14 +497,14 @@ async def _on_session_start_error(self, session_id: str) -> None:
         try:
             response = await self._uipath.api_client.request_async(
                 "POST",
-                f"agenthub_/mcp/{self.slug}/out/message?sessionId={session_id}",  # type: ignore
+                f"agenthub_/mcp/{self.slug}/out/message?sessionId={session_id}",
                 json=JSONRPCResponse(
                     jsonrpc="2.0",
                     id=0,
                     result={
                         "protocolVersion": "initialize-failure",
                         "capabilities": {},
-                        "serverInfo": {"name": self.slug, "version": "1.0"},  # type: ignore
+                        "serverInfo": {"name": self.slug, "version": "1.0"},
                     },
                 ).model_dump(),
             )
@@ -574,7 +576,7 @@ async def _on_runtime_abort(self) -> None:
         try:
             response = await self._uipath.api_client.request_async(
                 "POST",
-                f"agenthub_/mcp/{self.slug}/runtime/abort?runtimeId={self._runtime_id}",  # type: ignore
+                f"agenthub_/mcp/{self.slug}/runtime/abort?runtimeId={self._runtime_id}",
             )
             if response.status_code == 202:
                 logger.info(
@@ -618,7 +620,7 @@ def packaged(self) -> bool:
 
     @property
     def slug(self) -> str:
-        return self.context.server_slug or self._server.name
+        return self.context.server_slug or self._server.name  # type: ignore
 
     @property
     def server_type(self) -> UiPathServerType:

src/uipath_mcp/_cli/_runtime/_session.py

@@ -133,7 +133,7 @@ async def _run_server(self, server_params: StdioServerParameters) -> None:
                             try:
                                 if self._read_stream is None:
                                     logger.error("Read stream is not initialized")
-                                    continue
+                                    break
 
                                 session_message = await self._read_stream.receive()
                                 if isinstance(session_message, Exception):

src/uipath_mcp/_cli/cli_init.py

@@ -2,13 +2,15 @@
 import json
 import uuid
 from typing import Any, Callable, overload
+
 from uipath._cli._utils._console import ConsoleLogger
 from uipath._cli.middlewares import MiddlewareResult
 
 from ._utils._config import McpConfig
 
 console = ConsoleLogger()
 
+
 async def mcp_init_middleware_async(
     entrypoint: str,
     options: dict[str, Any] | None = None,
@@ -52,7 +54,7 @@ async def mcp_init_middleware_async(
             with open(config_path, "w") as f:
                 json.dump(uipath_data, f, indent=2)
 
-        console.success(f"Created '{config_path}' file." )
+        console.success(f"Created '{config_path}' file.")
         return MiddlewareResult(should_continue=False)
 
     except Exception as e:

src/uipath_mcp/_cli/cli_new.py

@@ -1,13 +1,14 @@
 import os
 import shutil
-from typing import Tuple, Optional, List
+from typing import List, Optional, Tuple
 
 import click
 from uipath._cli._utils._console import ConsoleLogger
 from uipath._cli.middlewares import MiddlewareResult
 
 console = ConsoleLogger()
 
+
 def clean_directory(directory: str) -> None:
     """Clean up Python files in the specified directory.
 
@@ -20,11 +21,17 @@ def clean_directory(directory: str) -> None:
     for file_name in os.listdir(directory):
         file_path = os.path.join(directory, file_name)
 
-        if os.path.isfile(file_path) and file_name.endswith('.py'):
+        if os.path.isfile(file_path) and file_name.endswith(".py"):
             # Delete the file
             os.remove(file_path)
 
-def write_template_file(target_directory:str, file_path: str, file_name: str, replace_tuple: Optional[List[Tuple[str, str]]] =  None) -> None:
+
+def write_template_file(
+    target_directory: str,
+    file_path: str,
+    file_name: str,
+    replace_tuple: Optional[List[Tuple[str, str]]] = None,
+) -> None:
     """Write a template file to the target directory with optional placeholder replacements.
 
     Args:
@@ -37,9 +44,7 @@ def write_template_file(target_directory:str, file_path: str, file_name: str, re
     This function copies a template file to the target directory and optionally replaces placeholders
     with specified values. It logs a success message after creating the file.
     """
-    template_path = os.path.join(
-        os.path.dirname(__file__), file_path
-    )
+    template_path = os.path.join(os.path.dirname(__file__), file_path)
     target_path = os.path.join(target_directory, file_name)
     if replace_tuple is not None:
         # replace the template placeholders
@@ -67,24 +72,22 @@ def generate_files(target_directory: str, server_name: str):
     - pyproject.toml: Project metadata and dependencies
     """
     write_template_file(
-        target_directory,
-        "_templates/server.py.template",
-        "server.py",
-        None
+        target_directory, "_templates/server.py.template", "server.py", None
     )
     write_template_file(
         target_directory,
         "_templates/mcp.json.template",
         "mcp.json",
-        [("$server_name", server_name)]
+        [("$server_name", server_name)],
     )
     write_template_file(
         target_directory,
         "_templates/pyproject.toml.template",
         "pyproject.toml",
-        [("$project_name", server_name)]
+        [("$project_name", server_name)],
     )
 
+
 def mcp_new_middleware(name: str) -> MiddlewareResult:
     """Create a new MCP server project with template files.
 
@@ -105,7 +108,9 @@ def mcp_new_middleware(name: str) -> MiddlewareResult:
     directory = os.getcwd()
 
     try:
-        with console.spinner(f"Creating new mcp server '{name}' in current directory ..."):
+        with console.spinner(
+            f"Creating new mcp server '{name}' in current directory ..."
+        ):
             clean_directory(directory)
             generate_files(directory, name)
             init_command = """uipath init"""
@@ -117,11 +122,21 @@ def mcp_new_middleware(name: str) -> MiddlewareResult:
             line = click.style("═" * 60, bold=True)
 
             console.info(line)
-            console.info(click.style(f"""Start '{name}' as a self-hosted MCP server""", fg="magenta", bold=True))
+            console.info(
+                click.style(
+                    f"""Start '{name}' as a self-hosted MCP server""",
+                    fg="magenta",
+                    bold=True,
+                )
+            )
             console.info(line)
 
-            console.hint(f""" 1. Set {click.style("UIPATH_FOLDER_PATH", fg="cyan")} environment variable""")
-            console.hint(f""" 2. Start the server locally: {click.style(run_command, fg="cyan")}""")
+            console.hint(
+                f""" 1. Set {click.style("UIPATH_FOLDER_PATH", fg="cyan")} environment variable"""
+            )
+            console.hint(
+                f""" 2. Start the server locally: {click.style(run_command, fg="cyan")}"""
+            )
         return MiddlewareResult(should_continue=False)
     except Exception as e:
         console.error(f"Error creating demo agent {str(e)}")

src/uipath_mcp/middlewares.py

@@ -1,8 +1,9 @@
 from uipath._cli.middlewares import Middlewares
 
 from ._cli.cli_init import mcp_init_middleware
-from ._cli.cli_run import mcp_run_middleware
 from ._cli.cli_new import mcp_new_middleware
+from ._cli.cli_run import mcp_run_middleware
+
 
 def register_middleware():
     """This function will be called by the entry point system when uipath-mcp is installed"""