项目简介

Pipefy MCP Server 是一个开源的 MCP 服务器，旨在为 Pipefy 工作流管理平台提供 LLM 上下文服务。它允许用户通过 LLM 客户端安全地与 Pipefy 交互，例如创建卡片、更新字段信息、访问 Pipefy 资源等。

主要功能点

• Pipefy 集成: 提供与 Pipefy API 的集成，允许 LLM 客户端操作 Pipefy 中的卡片和数据。
• 工具注册: 注册了用于创建、获取 Pipefy 卡片的工具，方便 LLM 调用。
• 资源管理: 示例性地展示了如何定义和提供动态资源 (greeting)。
• 安全性: 通过 MCP 协议和 Pipefy 的 OAuth 认证机制，保证操作的安全性。

安装步骤

1. 确保已安装 Python 3.12 或更高版本。
2. 克隆仓库到本地：

   git clone https://github.com/gbrlcustodio/pipefy-mcp-server.git
   

3. 进入仓库目录：

   cd pipefy-mcp-server
   

4. 使用 uv (或 pip) 安装依赖：

   uv pip install .
   

   或者

   pip install .
   

服务器配置

MCP 客户端需要配置服务器连接信息。以下是一个示例 JSON 配置，用于连接到本地运行的 Pipefy MCP Server：

{
  "serverName": "PipefyMCP",
  "command": "pipefy-mcp-server",
  "args": [],
  "transport": "stdio"
}

• 'serverName': 服务器名称，自定义，用于在客户端标识连接。
• 'command': 启动服务器的命令，这里使用 'pipefy-mcp-server' (假设已将项目安装到 Python 环境)。
• 'args': 启动命令的参数，这里为空，表示不传递任何参数。
• 'transport': 传输协议，这里使用 'stdio' (标准输入输出)。

基本使用方法

1. 配置环境变量: 需要设置 Pipefy API 相关的环境变量，例如 'PIPEFY_GRAPHQL_URL', 'PIPEFY_OAUTH_URL', 'PIPEFY_OAUTH_CLIENT', 'PIPEFY_OAUTH_SECRET'。这些信息需要从您的 Pipefy 应用中获取。可以将这些变量设置在 '.env' 文件中，与 'pipefy-mcp-server' 命令在同一目录下。
2. 启动服务器: 在仓库根目录下，运行命令 'pipefy-mcp-server' 启动服务器。
3. 连接客户端: 在 MCP 客户端中，配置上述服务器配置信息，建立与 Pipefy MCP Server 的连接。
4. 使用工具和资源: 在客户端中，可以调用服务器提供的工具 (如 'create_card', 'get_card') 和资源 (如 'greeting://{name}')，与 Pipefy 进行交互。