purview-mcp-server 1.13.1__tar.gz

purview_mcp_server-1.13.1/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: purview-mcp-server
+Version: 1.13.1
+Summary: Model Context Protocol server for Microsoft Purview
+License-Expression: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Database
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: pvw-cli>=1.13.1
+Requires-Dist: fastmcp>=2.0.0
+Requires-Dist: pydantic<3.0.0,>=2.5.0
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: azure-identity>=1.12.0
+Requires-Dist: pandas>=1.5.0
+
+# Purview MCP Server
+
+FastMCP-based server that exposes Microsoft Purview data governance operations through the [Model Context Protocol](https://modelcontextprotocol.io/).
+
+> **Full documentation:** [`docs/purview-mcp-server.md`](../../docs/purview-mcp-server.md)
+
+---
+
+## Quick Start
+
+```powershell
+# stdio (default) — from repo root, venv active
+$env:PURVIEW_ACCOUNT_NAME = "your-account"
+python tools/PurviewMCPServer/server.py
+```
+
+```powershell
+# Streamable-HTTP
+$env:PURVIEW_MCP_TRANSPORT = "streamable-http"
+$env:PURVIEW_MCP_PORT      = "8000"
+python tools/PurviewMCPServer/server.py
+# endpoint: http://127.0.0.1:8000/mcp
+```
+
+```powershell
+# Azure Functions (func host)
+cd tools/hosting/app && func start --port 7073
+# endpoint: http://localhost:7073/api/mcp
+```
+
+---
+
+## Transport Protocols
+
+| Transport | Env value | VS Code mcp.json type | Endpoint |
+|---|---|---|---|
+| stdio (default) | `stdio` | `"command"` | process stdin/stdout |
+| Streamable-HTTP | `streamable-http` or `http` | `"http"` | `/mcp` (standalone) or `/api/mcp` (Azure Functions) |
+| SSE (legacy) | `sse` | `"sse"` | `/sse` (standalone only — not compatible with Azure Functions) |
+
+---
+
+## VS Code mcp.json
+
+```json
+{
+  "servers": {
+    "purview-mcp-server-stdio": {
+      "command": "./.venv/Scripts/python",
+      "args": ["tools/PurviewMCPServer/server.py"],
+      "env": { "PURVIEW_ACCOUNT_NAME": "your-account" }
+    },
+    "purview-mcp-server-http": {
+      "type": "http",
+      "url": "http://localhost:7073/api/mcp"
+    }
+  }
+}
+```
+
+---
+
+## Environment Variables
+
+| Variable | Required | Default | Description |
+|---|---|---|---|
+| `PURVIEW_ACCOUNT_NAME` | Yes | — | Purview account name (no suffix) |
+| `AZURE_TENANT_ID` | No | — | Azure tenant GUID |
+| `AZURE_CLIENT_ID` | No | — | Service principal client ID |
+| `AZURE_CLIENT_SECRET` | No | — | Service principal secret |
+| `AZURE_REGION` | No | public | Sovereign cloud: `usgov`, `china` |
+| `PURVIEW_MAX_RETRIES` | No | `3` | API retry count |
+| `PURVIEW_TIMEOUT` | No | `30` | Request timeout (seconds) |
+| `PURVIEW_BATCH_SIZE` | No | `100` | Bulk operation batch size |
+| `PURVIEW_MCP_TRANSPORT` | No | `stdio` | Transport protocol |
+| `PURVIEW_MCP_HOST` | No | `127.0.0.1` | Bind host (HTTP/SSE modes) |
+| `PURVIEW_MCP_PORT` | No | `8000` | Bind port (HTTP/SSE modes) |
+
+Copy `.env.example` to `.env` and fill in your values. Never commit `.env`.
+
+---
+
+## Available Tools (37 + registry)
+
+| Category | Tools |
+|---|---|
+| Entity (8) | `get_entity`, `create_entity`, `update_entity`, `delete_entity`, `search_entities`, `batch_create_entities`, `batch_update_entities`, `import_entities_from_csv` |
+| Glossary (3) | `get_glossary_terms`, `create_glossary_term`, `assign_term_to_entities` |
+| Unified Catalog (11) | `uc_list_domains`, `uc_get_domain`, `uc_create_domain`, `uc_list_terms`, `uc_get_term`, `uc_create_term`, `uc_search_terms`, `uc_list_custom_metadata_defs`, `uc_cleanup_metadata_definition`, `uc_delete_metadata_definition`, `uc_delete_metadata_from_asset` |
+| Collections (5) | `list_collections`, `get_collection`, `create_collection`, `delete_collection`, `get_collection_path` |
+| Lineage (2) | `get_lineage`, `create_lineage` |
+| Search (2) | `search_suggest`, `search_browse` |
+| Type Defs (2) | `get_typedef`, `list_typedefs` |
+| Relationships (3) | `create_relationship`, `get_relationship`, `delete_relationship` |
+| Account + Registry (3) | `get_account_properties`, `list_available_operations`, `invoke_operation` |
+
+---
+
+## Recommended First Commands
+
+```
+1) list_available_operations()
+2) get_account_properties()
+3) search_entities(query="customer", limit=5)
+4) uc_list_domains()
+```
+
+---
+
+## Files
+
+| File | Purpose |
+|---|---|
+| `server.py` | FastMCP server — all 37 tool definitions |
+| `config.py` | `PurviewMCPConfig` frozen dataclass — env var parsing and validation |
+| `__version__.py` | Package version |
+| `.env.example` | Environment variable template |
+| `PROMPT_INSTRUCTIONS.md` | Detailed prompt guidance for AI assistants |
+| `pyproject.toml` | Package metadata (`purview-mcp-server`) |
+| `Dockerfile` | Container image for standalone deployment |
+| `docker-compose.yml` | Local container stack |
+
+For Azure Functions hosting files, see `tools/hosting/`.
+
+---
+
+See [`docs/purview-mcp-server.md`](../../docs/purview-mcp-server.md) for the full reference including client setup for Claude Code and Cursor, Azure Functions deployment, all prompt examples, workflows, and troubleshooting.

purview_mcp_server-1.13.1/README.md

@@ -0,0 +1,127 @@
+# Purview MCP Server
+
+FastMCP-based server that exposes Microsoft Purview data governance operations through the [Model Context Protocol](https://modelcontextprotocol.io/).
+
+> **Full documentation:** [`docs/purview-mcp-server.md`](../../docs/purview-mcp-server.md)
+
+---
+
+## Quick Start
+
+```powershell
+# stdio (default) — from repo root, venv active
+$env:PURVIEW_ACCOUNT_NAME = "your-account"
+python tools/PurviewMCPServer/server.py
+```
+
+```powershell
+# Streamable-HTTP
+$env:PURVIEW_MCP_TRANSPORT = "streamable-http"
+$env:PURVIEW_MCP_PORT      = "8000"
+python tools/PurviewMCPServer/server.py
+# endpoint: http://127.0.0.1:8000/mcp
+```
+
+```powershell
+# Azure Functions (func host)
+cd tools/hosting/app && func start --port 7073
+# endpoint: http://localhost:7073/api/mcp
+```
+
+---
+
+## Transport Protocols
+
+| Transport | Env value | VS Code mcp.json type | Endpoint |
+|---|---|---|---|
+| stdio (default) | `stdio` | `"command"` | process stdin/stdout |
+| Streamable-HTTP | `streamable-http` or `http` | `"http"` | `/mcp` (standalone) or `/api/mcp` (Azure Functions) |
+| SSE (legacy) | `sse` | `"sse"` | `/sse` (standalone only — not compatible with Azure Functions) |
+
+---
+
+## VS Code mcp.json
+
+```json
+{
+  "servers": {
+    "purview-mcp-server-stdio": {
+      "command": "./.venv/Scripts/python",
+      "args": ["tools/PurviewMCPServer/server.py"],
+      "env": { "PURVIEW_ACCOUNT_NAME": "your-account" }
+    },
+    "purview-mcp-server-http": {
+      "type": "http",
+      "url": "http://localhost:7073/api/mcp"
+    }
+  }
+}
+```
+
+---
+
+## Environment Variables
+
+| Variable | Required | Default | Description |
+|---|---|---|---|
+| `PURVIEW_ACCOUNT_NAME` | Yes | — | Purview account name (no suffix) |
+| `AZURE_TENANT_ID` | No | — | Azure tenant GUID |
+| `AZURE_CLIENT_ID` | No | — | Service principal client ID |
+| `AZURE_CLIENT_SECRET` | No | — | Service principal secret |
+| `AZURE_REGION` | No | public | Sovereign cloud: `usgov`, `china` |
+| `PURVIEW_MAX_RETRIES` | No | `3` | API retry count |
+| `PURVIEW_TIMEOUT` | No | `30` | Request timeout (seconds) |
+| `PURVIEW_BATCH_SIZE` | No | `100` | Bulk operation batch size |
+| `PURVIEW_MCP_TRANSPORT` | No | `stdio` | Transport protocol |
+| `PURVIEW_MCP_HOST` | No | `127.0.0.1` | Bind host (HTTP/SSE modes) |
+| `PURVIEW_MCP_PORT` | No | `8000` | Bind port (HTTP/SSE modes) |
+
+Copy `.env.example` to `.env` and fill in your values. Never commit `.env`.
+
+---
+
+## Available Tools (37 + registry)
+
+| Category | Tools |
+|---|---|
+| Entity (8) | `get_entity`, `create_entity`, `update_entity`, `delete_entity`, `search_entities`, `batch_create_entities`, `batch_update_entities`, `import_entities_from_csv` |
+| Glossary (3) | `get_glossary_terms`, `create_glossary_term`, `assign_term_to_entities` |
+| Unified Catalog (11) | `uc_list_domains`, `uc_get_domain`, `uc_create_domain`, `uc_list_terms`, `uc_get_term`, `uc_create_term`, `uc_search_terms`, `uc_list_custom_metadata_defs`, `uc_cleanup_metadata_definition`, `uc_delete_metadata_definition`, `uc_delete_metadata_from_asset` |
+| Collections (5) | `list_collections`, `get_collection`, `create_collection`, `delete_collection`, `get_collection_path` |
+| Lineage (2) | `get_lineage`, `create_lineage` |
+| Search (2) | `search_suggest`, `search_browse` |
+| Type Defs (2) | `get_typedef`, `list_typedefs` |
+| Relationships (3) | `create_relationship`, `get_relationship`, `delete_relationship` |
+| Account + Registry (3) | `get_account_properties`, `list_available_operations`, `invoke_operation` |
+
+---
+
+## Recommended First Commands
+
+```
+1) list_available_operations()
+2) get_account_properties()
+3) search_entities(query="customer", limit=5)
+4) uc_list_domains()
+```
+
+---
+
+## Files
+
+| File | Purpose |
+|---|---|
+| `server.py` | FastMCP server — all 37 tool definitions |
+| `config.py` | `PurviewMCPConfig` frozen dataclass — env var parsing and validation |
+| `__version__.py` | Package version |
+| `.env.example` | Environment variable template |
+| `PROMPT_INSTRUCTIONS.md` | Detailed prompt guidance for AI assistants |
+| `pyproject.toml` | Package metadata (`purview-mcp-server`) |
+| `Dockerfile` | Container image for standalone deployment |
+| `docker-compose.yml` | Local container stack |
+
+For Azure Functions hosting files, see `tools/hosting/`.
+
+---
+
+See [`docs/purview-mcp-server.md`](../../docs/purview-mcp-server.md) for the full reference including client setup for Claude Code and Cursor, Azure Functions deployment, all prompt examples, workflows, and troubleshooting.

purview_mcp_server-1.13.1/purview_mcp_server/__init__.py

@@ -0,0 +1,11 @@
+# SPDX-License-Identifier: Apache-2.0
+
+"""
+Microsoft Purview MCP Server
+
+Enables LLM-powered data governance workflows
+"""
+
+from .__version__ import __version__, __author__, __description__
+
+__all__ = ["__version__", "__author__", "__description__"]

purview_mcp_server-1.13.1/purview_mcp_server/__version__.py

@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: Apache-2.0
+
+"""Version information for Purview MCP Server."""
+
+__version__ = "1.13.1"
+__author__ = "Ayoub KEBAILI"
+__description__ = (
+    "A Model Context Protocol server for Microsoft Purview enabling LLM-powered data governance workflows."
+)

purview_mcp_server-1.13.1/purview_mcp_server/config.py

@@ -0,0 +1,61 @@
+# SPDX-License-Identifier: Apache-2.0
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+from typing import Literal
+
+Transport = Literal["stdio", "sse", "streamable-http"]
+
+
+def _as_int(value: str | None, default: int, name: str) -> int:
+    if value is None:
+        return default
+    try:
+        return int(value.strip())
+    except ValueError as exc:
+        raise ValueError(f"{name} must be an integer, got: {value!r}") from exc
+
+
+@dataclass(frozen=True)
+class PurviewMCPConfig:
+    # --- Purview client settings ---
+    account_name: str
+    tenant_id: str | None
+    azure_region: str | None
+    max_retries: int
+    timeout: int
+    batch_size: int
+
+    # --- MCP server / transport settings ---
+    transport: Transport
+    host: str
+    port: int
+
+    @classmethod
+    def from_env(cls) -> "PurviewMCPConfig":
+        account_name = os.getenv("PURVIEW_ACCOUNT_NAME", "").strip()
+        if not account_name:
+            raise ValueError("PURVIEW_ACCOUNT_NAME is required.")
+
+        transport_raw = os.getenv("PURVIEW_MCP_TRANSPORT", "stdio").strip().lower()
+        # Accept "http" as an alias for "streamable-http"
+        if transport_raw == "http":
+            transport_raw = "streamable-http"
+        if transport_raw not in {"stdio", "sse", "streamable-http"}:
+            raise ValueError(
+                "PURVIEW_MCP_TRANSPORT must be one of: stdio, sse, streamable-http, http"
+            )
+        typed_transport: Transport = transport_raw  # type: ignore[assignment]
+
+        return cls(
+            account_name=account_name,
+            tenant_id=os.getenv("AZURE_TENANT_ID") or None,
+            azure_region=os.getenv("AZURE_REGION") or None,
+            max_retries=_as_int(os.getenv("PURVIEW_MAX_RETRIES"), 3, "PURVIEW_MAX_RETRIES"),
+            timeout=_as_int(os.getenv("PURVIEW_TIMEOUT"), 30, "PURVIEW_TIMEOUT"),
+            batch_size=_as_int(os.getenv("PURVIEW_BATCH_SIZE"), 100, "PURVIEW_BATCH_SIZE"),
+            transport=typed_transport,
+            host=os.getenv("PURVIEW_MCP_HOST", "127.0.0.1").strip(),
+            port=_as_int(os.getenv("PURVIEW_MCP_PORT"), 8000, "PURVIEW_MCP_PORT"),
+        )