Ayx MCP Wrapper

🚀 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 服務器提供了按功能組織的全面工具：

集合管理

工作流操作

用戶管理

調度管理

作業監控

憑證與連接

開發

設置開發環境

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

# 安裝依賴
uv sync

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

貢獻代碼

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

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

📄 許可證

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

相關項目

• Model Context Protocol - MCP 規範。
• Claude Desktop - Claude 桌面應用程序。

為社區用心打造 ❤️