chore: add Python server SDK (#92)

Author: yannj-fr

.github/workflows/ci.yml

@@ -17,6 +17,7 @@ jobs:
       ts_client_files: ${{ steps.filter.outputs.ts_client_files }}
       ts_server_files: ${{ steps.filter.outputs.ts_server_files }}
       ruby_sdk_files: ${{ steps.filter.outputs.ruby_sdk_files }}
+      python_sdk_files: ${{ steps.filter.outputs.python_sdk_files }}
       example_files: ${{ steps.filter.outputs.example_files }}
     steps:
       - uses: actions/checkout@v4
@@ -30,6 +31,8 @@ jobs:
               - 'sdks/typescript/server/**'
             ruby_sdk_files:
               - 'sdks/ruby/**'
+            python_sdk_files:
+              - 'sdks/python/**'
             example_files:
               - 'examples/**'
 
@@ -99,6 +102,43 @@ jobs:
       - name: Run tests
         run: pnpm test:ruby
 
+  python_sdk_test:
+    needs: filter_changed_paths
+    if: needs.filter_changed_paths.outputs.python_sdk_files == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: uv sync --dev
+        working-directory: sdks/python/server
+
+      - name: Lint with ruff
+        run: uv run ruff check
+        working-directory: sdks/python/server
+
+      - name: Type check with pyright
+        run: uv run pyright
+        working-directory: sdks/python/server
+
+      - name: Run tests
+        run: uv run pytest
+        working-directory: sdks/python/server
+
+      - name: Build package
+        run: uv build
+        working-directory: sdks/python/server
+
   release_ts_client:
     needs: [js_build_and_test, filter_changed_paths]
     if: github.ref == 'refs/heads/main' && needs.filter_changed_paths.outputs.ts_client_files == 'true'
@@ -198,4 +238,50 @@ jobs:
         working-directory: sdks/ruby
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npx semantic-release
+        run: npx semantic-release
+
+  release_python_sdk:
+    name: Release Python SDK
+    needs: [python_sdk_test, release_ruby_sdk, filter_changed_paths]
+    if: >
+      always() &&
+      github.ref == 'refs/heads/main' &&
+      needs.filter_changed_paths.outputs.python_sdk_files == 'true' &&
+      needs.python_sdk_test.result == 'success'
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: write # to push commits and tags
+      id-token: write # for trusted publishing to PyPI
+      issues: write # to comment on issues
+      pull-requests: write # to comment on pull requests
+    steps:
+      - uses: actions/checkout@v4
+        with: { fetch-depth: 0 }
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with: { version: 10 }
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with: { node-version: 22.x, cache: 'pnpm' }
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+      - name: Install Python dependencies
+        run: uv sync --dev
+        working-directory: sdks/python/server
+      - name: Build package
+        run: uv build
+        working-directory: sdks/python/server
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: sdks/python/server/dist/
+          print-hash: true

docs/src/guide/introduction.md

@@ -14,6 +14,7 @@ MCP-UI provides SDKs for multiple languages, including:
 - **`@mcp-ui/client`**: A Typescript package with UI components for easy rendering of interactive UI. It includes a React component (`<UIResourceRenderer />`) and a standard Web Component (`<ui-resource-renderer>`).
 - **`@mcp-ui/server`**: A Typescript package with helper functions (like `createUIResource`) for server-side logic to easily construct `UIResource` objects.
 - **`mcp_ui_server`**: A Ruby gem with helper methods (like `create_ui_resource`) for server-side logic in Ruby applications.
+- **`mcp-ui-server`**: A Python package with helper methods (like `create_UIResource`) for server-side logic in Python applications.
 
 ## The Interactive UI Resource Protocol
 

docs/src/guide/server/python/overview.md

@@ -0,0 +1,43 @@
+# mcp-ui-server Overview
+
+The `mcp-ui-server` package provides utilities to generate UI resources (`UIResource`) on your MCP server. It allows you to define UI snippets on the server-side, which can then be seamlessly and securely rendered on the client.
+
+For a complete example, see the [`python-server-demo`](https://github.com/idosal/mcp-ui/tree/main/examples/python-server-demo).
+
+## Key Exports
+
+- **`create_ui_resource(options_dict: dict[str, Any]) -> UIResource`**:
+  The primary function for creating UI snippets. It takes a dictionary of options to define the URI, content (direct HTML or external URL), and encoding method (text or blob).
+
+## Purpose
+
+- **Ease of Use**: Simplifies the creation of valid `UIResource` objects.
+- **Validation**: Includes basic validation (e.g., URI prefixes matching content type).
+- **Encoding**: Handles Base64 encoding when `encoding: 'blob'` is specified.
+- **MCP Integration**: Proper integration with the MCP Python SDK using `EmbeddedResource`.
+
+## Installation
+
+Install the package using pip or your preferred package manager:
+
+```bash
+pip install mcp-ui-server
+```
+
+Or with uv:
+
+```bash
+uv add mcp-ui-server
+```
+
+## Building
+
+This package is built using Python's standard build tools and distributed via PyPI. It includes full type annotations and is compatible with Python 3.10+.
+
+To build the package from source:
+
+```bash
+uv build
+```
+
+See the [Server SDK Usage & Examples](./usage-examples.md) page for practical examples.