AYX-MCP-Wrapper - 非官方Alteryx服務器接口封裝，MCP協議支持多類型管理操作

Ayx MCP Wrapper

AYX-MCP-Wrapper是一個非官方的Alteryx服務器接口封裝，提供基於Model Context Protocol的全面服務，支持工作流管理、集合管理、用戶管理、計劃任務和憑證管理等操作。

開發者工具研究與數據 #工作流管理 #用戶管理 #計劃任務 #數據集成 .Python

評分 : 2.5分

下載量 : 2

更新時間 : 2025-07-24

什麼是 Alteryx MCP 服務器？

Alteryx MCP 服務器是一個 Model Context Protocol (MCP) 服務器，它為 AI 助手和其他 MCP 客戶端提供了與 Alteryx Server 交互的接口。該服務器允許用戶管理流程、集合、用戶、計劃和憑證等。

如何使用 Alteryx MCP 服務器？

通過設置環境變量並運行 MCP 服務器，您可以將其集成到 Claude Desktop 或 Cursor IDE 等工具中。您還可以通過命令行直接運行 MCP 服務器。

適用場景

適合需要與 Alteryx Server 進行深度集成的應用場景，如自動化工作流執行、數據管理、用戶權限控制等。

主要功能

高級搜索支持按名稱、ID 或其他屬性查找用戶、工作流和資產。

工作流操作允許執行、轉移和管理工作流，提供對工作流的全面控制。

工作流資產支持下載工作流包並提取 XML 文件以進行分析。

作業監控即時跟蹤和管理工作流執行作業的狀態。

集合管理創建、更新、刪除和組織集合，便於資源管理。

用戶管理管理用戶及其資產和權限，確保數據安全。

計劃管理創建和管理工作流計劃，實現自動化任務。

憑證管理處理服務器憑證和安全連接，保障數據傳輸安全。

優勢與侷限性

優勢

提供與 Alteryx Server 的無縫集成，簡化數據管理和自動化任務。

支持多種客戶端工具（如 Claude Desktop 和 Cursor）的集成。

提供豐富的 API 功能，滿足複雜的數據處理需求。

易於配置和部署，適合各種規模的企業使用。

侷限性

需要一定的技術背景來配置和維護。

依賴於 Alteryx Server 的可用性和穩定性。

對於非技術用戶來說，部分功能可能較為複雜。

需要額外的開發工作才能完全利用其所有功能。

如何使用

安裝 MCP 服務器

使用 uv 或 pip 安裝 MCP 服務器。

配置環境變量

設置 Alteryx 服務器的 API 地址、OAuth2 憑據等環境變量。

運行 MCP 服務器

使用 uv 運行 MCP 服務器，並選擇適當的傳輸方式（如 stdio、sse 或 streamable-http）。

使用案例

自動化工作流執行通過 MCP 服務器自動執行工作流，提高數據處理效率。

管理用戶資產通過 MCP 服務器查詢和管理用戶的所有資產。

監控作業狀態即時監控工作流執行作業的狀態，及時發現問題。

常見問題

如何解決認證失敗的問題？

MCP 服務器無法啟動怎麼辦？

如何查看 MCP 服務器的日誌？

MCP 服務器支持哪些傳輸方式？

🚀 AYX-MCP-Wrapper

AYX-MCP-Wrapper 是一個模型上下文協議（MCP）服務器，它為 Alteryx 服務器提供了全面的接口。藉助這個包裝器，AI 助手和其他 MCP 客戶端能夠與 Alteryx 服務器進行交互，實現對工作流、集合、用戶、調度、憑證等的管理。

🚀 快速開始

本項目是一個個人發起的項目，與任何公司均無關聯，也未得到任何公司的認可或支持。即便維護者是相關公司的員工，該項目也是獨立開發的，沒有任何官方支持。請在使用前知悉。

✨ 主要特性

高級搜索：通過靈活的搜索選項查找用戶、工作流和資產。
工作流操作：全面控制工作流的執行、轉移和管理。
工作流資產：下載工作流包並提取 XML 進行分析。
作業監控：實時跟蹤和管理工作流執行作業。
集合管理：創建、更新、刪除和組織集合。
用戶管理：高效管理用戶、其資產和權限。
調度管理：創建和管理工作流調度與自動化。
憑證管理：處理服務器憑證並確保安全連接。

📦 安裝指南

前提條件

Python 3.10+ - 支持類型提示的現代 Python 版本。
Alteryx Server - 已啟用 API 訪問。
OAuth2 憑證 - 用於身份驗證的客戶端 ID 和密鑰。

使用 uv 快速開始（推薦）

# 若尚未安裝 uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# 安裝 MCP 服務器
uv pip install mcp-server-alteryx

使用 pip 安裝

pip install mcp-server-alteryx

從源代碼安裝

git clone https://github.com/jupiterbak/AYX-MCP-Wrapper.git
cd AYX-MCP-Wrapper
uv sync
uv run pip install -e .

🔧 配置

環境變量

使用環境變量設置服務器憑證：

# 必需：服務器 API URL
export ALTERYX_API_HOST="https://your-server.com/webapi/"

# 必需：OAuth2 客戶端憑證
export ALTERYX_CLIENT_ID="your-client-id"
export ALTERYX_CLIENT_SECRET="your-client-secret"

# 可選：SSL 驗證（默認：true）
export ALTERYX_VERIFY_SSL="1"

# 可選：臨時文件夾
export ALTERYX_TEMP_DIRECTORY="your-temp-directory"

# 可選：日誌級別
export LOG_LEVEL="INFO"

配置文件

也可以在項目根目錄下創建一個 .env 文件：

ALTERYX_API_HOST=https://your-server.com/webapi/
ALTERYX_CLIENT_ID=your-client-id
ALTERYX_CLIENT_SECRET=your-client-secret
ALTERYX_VERIFY_SSL=1
ALTERYX_TEMP_DIRECTORY=your-temp-directory
LOG_LEVEL=INFO

💻 使用示例

Claude Desktop 集成

要在 Claude Desktop 中使用此 MCP 服務器，請在 Claude Desktop 設置中添加以下配置：

{
  "mcpServers": {
    "alteryx": {
      "command": "uvx",
      "args": ["mcp-server-alteryx", "--transport", "stdio"],
      "env": {
        "ALTERYX_API_HOST": "https://your-server.com/webapi/",
        "ALTERYX_CLIENT_ID": "your-client-id",
        "ALTERYX_CLIENT_SECRET": "your-client-secret",
        "ALTERYX_VERIFY_SSL": "1",
        "ALTERYX_TEMP_DIRECTORY": "your-temp-directory"
      }
    }
  }
}

不過，我們建議結合“Sequential Thinking”工具一起使用：

{
  "mcpServers": {
    "sequential-thinking": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-sequential-thinking"
      ]
    },
    "alteryx": {
      "command": "uvx",
      "args": ["mcp-server-alteryx", "--transport", "stdio"],
      "env": {
        "ALTERYX_API_HOST": "http://localhost/webapi/",
        "ALTERYX_CLIENT_ID": "your-client-id",
        "ALTERYX_CLIENT_SECRET": "your-client-secret",
        "ALTERYX_VERIFY_SSL": "1",
        "ALTERYX_TEMP_DIRECTORY": "your-temp-directory"
      }
    }
  }
}

配置選項：

command：要使用的 uvx 可執行文件。
args：MCP 服務器的命令行參數。
env：用於服務器身份驗證的環境變量。

傳輸選項：

stdio：標準輸入/輸出（推薦用於 Claude Desktop）。
sse：服務器發送事件。
streamable-http：HTTP 流。

Cursor 集成

要在 Cursor IDE 中集成，請在 Cursor 設置中添加以下內容：

{
  "mcpServers": {
    "alteryx": {
      "command": "uvx",
      "args": ["mcp-server-alteryx", "--transport", "stdio"],
      "env": {
        "ALTERYX_API_HOST": "https://your-alteryx-server.com/webapi/",
        "ALTERYX_CLIENT_ID": "your-client-id",
        "ALTERYX_CLIENT_SECRET": "your-client-secret",
        "ALTERYX_TEMP_DIRECTORY": "your-temp-directory"
      }
    }
  }
}

命令行界面

MCP 服務器可以使用不同的傳輸選項運行：

# 使用 stdio 傳輸（默認）
uvx run src.main --transport stdio

# 使用服務器發送事件（SSE）
uvx run src.main --transport sse

# 使用 HTTP 流
uvx run src.main --transport streamable-http

# 設置日誌級別
uvx run src.main --log-level DEBUG

# 使用自定義配置運行
uvx run src.main --transport stdio --log-level INFO

📚 詳細文檔

可用工具

MCP 服務器提供了按功能組織的全面工具：

集合管理

功能	描述	參數
`get_all_collections()`	獲取所有可訪問的集合	無
`get_collection_by_id(collection_id)`	獲取特定集合的詳細信息	`collection_id: str`
`create_collection(name)`	創建新集合	`name: str`
`update_collection_name_or_owner(collection_id, name, owner_id)`	更新集合屬性	`collection_id: str, name: str, owner_id: str`
`add_workflow_to_collection(collection_id, workflow_id)`	將工作流添加到集合中	`collection_id: str, workflow_id: str`
`remove_workflow_from_collection(collection_id, workflow_id)`	從集合中移除工作流	`collection_id: str, workflow_id: str`
`add_schedule_to_collection(collection_id, schedule_id)`	將調度添加到集合中	`collection_id: str, schedule_id: str`
`remove_schedule_from_collection(collection_id, schedule_id)`	從集合中移除調度	`collection_id: str, schedule_id: str`
`delete_collection(collection_id)`	刪除集合	`collection_id: str`

工作流操作

功能	描述	參數
`get_all_workflows()`	獲取所有可訪問的工作流	無
`get_workflow_by_id(workflow_id)`	獲取特定工作流的詳細信息	`workflow_id: str`
`update_workflow_name_or_comment(workflow_id, name, comment)`	更新工作流屬性	`workflow_id: str, name: str, comment: str`
`transfer_workflow(workflow_id, new_owner_id)`	轉移工作流所有權	`workflow_id: str, new_owner_id: str`
`get_workflow_jobs(workflow_id)`	獲取工作流的作業	`workflow_id: str`
`start_workflow_execution(workflow_id, input_data)`	啟動工作流執行並返回作業 ID	`workflow_id: str, input_data: List[InputData]`
`execute_workflow_with_monitoring(workflow_id, input_data)`	執行工作流並監控完成情況	`workflow_id: str, input_data: List[InputData]`
`download_workflow_package_file(workflow_id, output_directory)`	下載工作流包	`workflow_id: str, output_directory: str`
`get_workflow_xml(workflow_id)`	提取工作流 XML	`workflow_id: str`

用戶管理

功能	描述	參數
`get_all_users()`	獲取所有可訪問的用戶	無
`get_user_by_id(user_id)`	獲取特定用戶的詳細信息	`user_id: str`
`get_user_by_email(email)`	通過電子郵件查找用戶	`email: str`
`get_user_by_name(name)`	通過姓名查找用戶	`name: str`
`get_user_by_first_name(first_name)`	通過名字查找用戶	`first_name: str`
`get_all_user_assets(user_id)`	獲取用戶擁有的所有資產	`user_id: str`
`get_user_assets_by_type(user_id, asset_type)`	獲取特定類型的資產	`user_id: str, asset_type: str`
`update_user_details(user_id, first_name, last_name, email)`	更新用戶信息	`user_id: str, first_name: str, last_name: str, email: str`
`transfer_all_assets(user_id, new_owner_id, transfer_workflows, transfer_schedules, transfer_collections)`	轉移用戶資產	`user_id: str, new_owner_id: str, transfer_workflows: bool, transfer_schedules: bool, transfer_collections: bool`
`deactivate_user(user_id)`	停用用戶	`user_id: str`
`reset_user_password(user_id)`	重置用戶密碼	`user_id: str`

調度管理

功能	描述	參數
`get_all_schedules()`	獲取所有可訪問的調度	無
`get_schedule_by_id(schedule_id)`	獲取特定調度的詳細信息	`schedule_id: str`
`deactivate_schedule(schedule_id)`	停用調度	`schedule_id: str`
`activate_schedule(schedule_id)`	啟用調度	`schedule_id: str`
`update_schedule_name_or_comment(schedule_id, name, comment)`	更新調度屬性	`schedule_id: str, name: str, comment: str`
`change_schedule_owner(schedule_id, new_owner_id)`	更改調度所有權	`schedule_id: str, new_owner_id: str`

作業監控

功能	描述	參數
`get_all_job_messages(job_id)`	獲取特定作業的消息	`job_id: str`
`get_job_by_id(job_id)`	獲取作業詳細信息	`job_id: str`
`get_job_output_data(job_id)`	從已完成的作業中獲取輸出數據文件	`job_id: str`

憑證與連接

功能	描述	參數
`get_all_credentials()`	獲取所有可訪問的憑證	無
`get_credential_by_id(credential_id)`	獲取特定憑證的詳細信息	`credential_id: str`
`lookup_connection(connection_id)`	查找 DCM 連接	`connection_id: str`
`get_connection_by_id(connection_id)`	獲取連接詳細信息	`connection_id: str`

開發

設置開發環境

# 克隆倉庫
git clone https://github.com/jupiterbak/AYX-MCP-Wrapper.git
cd AYX-MCP-Wrapper

# 安裝依賴
uv sync

# 以開發模式安裝
uv run pip install -e .

貢獻代碼

我們歡迎貢獻！請遵循以下步驟：

Fork 倉庫。
創建一個功能分支 (git checkout -b feature/amazing-feature)。
提交你的更改 (git commit -m 'Add amazing feature')。
推送到分支 (git push origin feature/amazing-feature)。
打開一個拉取請求。

📄 許可證

本項目採用 MIT 許可證 - 詳情請參閱 LICENSE 文件。