Ayx MCP Wrapper

🚀 AYX-MCP-Wrapper

AYX-MCP-Wrapper 是一个模型上下文协议（MCP）服务器，它为 Alteryx 服务器提供了全面的接口。借助这个包装器，AI 助手和其他 MCP 客户端能够与 Alteryx 服务器进行交互，实现对工作流、集合、用户、调度、凭证等的管理。

⚠️ 免责声明

这并非官方实现。

本项目是个人发起的，与任何公司均无关联，也未得到任何公司的认可或支持。即便维护者是相关公司的员工，本项目也是独立开发的，没有任何官方支持。

✨ 主要特性

• 高级搜索：通过灵活的搜索选项查找用户、工作流和资产。
• 工作流操作：全面控制工作流的执行、转移和管理。
• 工作流资产：下载工作流包并提取 XML 进行分析。
• 作业监控：实时跟踪和管理工作流执行作业。
• 集合管理：创建、更新、删除和组织集合。
• 用户管理：高效管理用户、其资产和权限。
• 调度管理：创建和管理工作流调度及自动化。
• 凭证管理：处理服务器凭证并确保安全连接。

📦 安装指南

先决条件

• Python 3.10+：支持类型提示的现代 Python 版本。
• Alteryx 服务器：已启用 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"
      }
    }
  }
}

不过，建议结合“顺序思维”工具使用：

{
  "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. 分叉 仓库。
2. 创建 一个功能分支 (git checkout -b feature/amazing-feature)。
3. 提交 你的更改 (git commit -m 'Add amazing feature')。
4. 推送 到分支 (git push origin feature/amazing-feature)。
5. 打开 一个拉取请求。

📄 许可证

本项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。

相关项目

• 模型上下文协议 - MCP 规范
• Claude Desktop - Claude 桌面应用程序

为社区用心打造 ❤️