使用说明
项目简介
Activepieces 是一个开源的AI自动化平台,它不仅可以作为Zapier的替代品用于构建自动化工作流,还能作为 Model Context Protocol (MCP) 服务器,为大型语言模型 (LLM) 客户端提供强大的后端支持。通过 Activepieces,你可以轻松地将各种数据资源和外部工具集成到你的 LLM 应用中,实现更智能、更定制化的交互体验。
主要功能点
- 资源 (Resources) 管理: Activepieces 可以托管和管理各种数据资源,例如数据库、云存储、API 接口等,并提供标准化的数据访问能力,让 LLM 能够便捷地获取上下文信息。
- 工具 (Tools) 注册与执行: 允许开发者注册和管理各种外部工具,例如数据分析工具、API 调用工具、第三方服务等,使 LLM 能够调用这些工具扩展自身的功能边界。Activepieces 提供了丰富的预制集成 (Pieces),涵盖 280+ 常用应用和服务,你可以直接使用这些 Pieces 作为工具,或者基于其提供的框架轻松创建自定义集成。
- Prompt 模板 (Prompts) 支持: 虽然仓库文档中没有明确提及 Prompt 模板,但 Activepieces 的自动化流程编排能力,以及其灵活的数据处理和工具集成机制,可以间接地支持 Prompt 模板的定义和渲染,从而实现可定制的 LLM 交互模式。
- 开放生态系统: 作为一个完全开源的项目,Activepieces 拥有活跃的社区和丰富的 Pieces 库,所有集成代码均开放可查,用户可以自由地扩展和定制功能。
- 多种部署方式: Activepieces 支持本地部署和云端部署,可以灵活地满足不同用户的需求。
安装步骤
- 环境准备: 确保你的机器上已安装 Node.js 和 npm (或 pnpm)。建议使用 Node.js v18 或 v20 版本。
- 获取代码: 使用 Git 克隆 Activepieces 仓库到本地:
git clone https://github.com/activepieces/activepieces.git cd activepieces - 安装依赖: 在项目根目录下运行以下命令安装项目依赖:
npm ci - 开发环境设置: 运行以下命令设置开发环境:
./tools/setup-dev.js - 启动服务: 在项目根目录下,根据你的需求选择以下命令启动 Activepieces 服务:
- 启动 Web 应用和 API 服务 (开发模式,支持热重载): 'nx run api:serve'
- 仅启动 API 服务 (开发模式,支持热重载): 'nx run api:serve-api'
服务器配置 (MCP 客户端配置)
要将 Activepieces 作为 MCP 服务器与 LLM 客户端连接,你需要在 MCP 客户端 (例如 Claude Desktop, Cursor, Windsurf) 中配置服务器连接信息。以下是通用的配置信息 JSON 示例,你需要根据你的实际部署情况进行调整:
{ "serverName": "Activepieces MCP Server", // MCP 服务器名称,自定义 "command": "nx", // 启动命令,通常为 nx (或 npx nx) "args": ["run", "api:serve-api"] // 启动参数,指定运行 api 项目的 serve-api 目标 }
参数注释:
- 'serverName': MCP 服务器的名称,可以自定义,用于在客户端中标识不同的 MCP 服务器连接。
- 'command': 启动 MCP 服务器的命令。 对于 Activepieces,通常使用 'nx' (或 'npx nx') 来运行 Nx 任务。
- 'args': 启动命令的参数。 '["run", "api:serve-api"]' 指定了要运行 'api' 项目的 'serve-api' 目标,这将启动 Activepieces 的 API 服务,使其作为 MCP 服务器运行。
注意:
- 请确保在 Activepieces 项目的根目录下运行 MCP 服务器启动命令。
- 如果你的 MCP 客户端支持配置工作目录 (working directory),请将其设置为 Activepieces 项目的根目录。
- 如果你的 Activepieces 实例部署在远程服务器,你需要将 'command' 和 'args' 替换为远程服务器上启动 Activepieces API 服务的实际命令和参数。
基本使用方法
- 启动 Activepieces 服务: 按照上述安装步骤启动 Activepieces API 服务。
- 配置 MCP 客户端: 在你的 LLM 客户端中,添加新的 MCP 服务器连接,并填入上述提供的配置信息 JSON。
- 连接测试: 在 LLM 客户端中测试与 Activepieces MCP 服务器的连接,确保连接成功。
- 使用 Pieces (工具和资源): 在 LLM 客户端中,你现在可以使用 Activepieces 提供的 Pieces 作为工具和资源,例如调用 Data Mapper Piece 进行数据转换,或者使用 HTTP Request Piece 调用外部 API。 你可以参考 Activepieces 官方文档和 Pieces 库列表,了解可用的 Pieces 及其使用方法。
- 自定义 Pieces (集成): 如果你需要更多特定的工具或资源集成,可以参考 Activepieces 的开发者文档,学习如何创建自定义的 Pieces,并将其注册到你的 Activepieces MCP 服务器中。
信息
分类
开发者工具