使用说明
项目简介
Paragon MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 客户端提供丰富的上下文信息和功能。它集成了 Paragon 的 ActionKit API,能够将 130 多个 SaaS 应用程序的预构建操作作为工具提供给 LLM 使用。
主要功能点
- SaaS 应用集成: 通过 Paragon ActionKit,集成如 Google Calendar、Salesforce、Slack 等 130+ SaaS 应用,使 LLM 能够执行如创建日历事件、查询 CRM 记录、发送 Slack 消息等操作。
- 用户授权管理: 利用 Paragon Connect Portal,引导用户授权集成,安全地进行 OAuth 2.0 和 API 密钥的接入。
- 自定义 Actions: 支持添加自定义 Actions (通过 OpenAPI 规范定义),扩展 LLM 的工具集。
- 实验性 Proxy API 工具: 可选启用 Proxy API 工具,允许 LLM 动态地构建 API 请求,更灵活地与集成应用交互。
- MCP 协议支持: 完全实现了 Model Context Protocol 服务器端规范,通过 JSON-RPC 协议与客户端通信,支持 SSE 等传输协议。
- 会话管理和能力声明: 服务器端负责管理会话,并向客户端声明其提供的工具和能力。
安装步骤
- 注册 Paragon 账号: 访问 Paragon 官网 注册并登录账号。
- 克隆仓库: 将仓库 'paragon-mcp' 克隆到本地。
- 安装依赖: 在仓库根目录下运行命令 'npm install' 安装项目依赖。
- 配置环境变量:
- 复制 '.env.example' 文件并重命名为 '.env':'cp .env.example .env'。
- 修改 '.env' 文件,配置以下必需环境变量:
- 'PROJECT_ID': 您的 Paragon 项目 ID。
- 'SIGNING_KEY' 或 'SIGNING_KEY_PATH': 您的 JWT 签名密钥,二选一配置。'SIGNING_KEY' 直接设置密钥字符串,'SIGNING_KEY_PATH' 设置密钥文件路径。
- 可选配置其他环境变量,如 'PORT' (服务器端口,默认为 3001), 'MCP_SERVER_URL' (MCP 服务器 URL,用于生成 Setup Links,默认为 'http://localhost:3001') 等。
- 启动服务器: 运行命令 'npm run start' 启动 MCP 服务器。服务器默认运行在 'http://localhost:3001'。
服务器配置 (MCP 客户端)
以下是 MCP 客户端 (例如 Cursor 或 Claude) 连接 Paragon MCP Server 的配置示例,以 JSON 格式提供。您需要将此配置添加到您的 MCP 客户端配置文件中。
{ "server name": "actionkit", // 服务器名称,您可以自定义,例如 "paragon-server" "command": "npx", // 启动服务器的命令,这里使用 npx 运行 mcp-remote "args": ["mcp-remote", "http://localhost:3001/sse?user=[user-id]"] // 传递给命令的参数数组 // "mcp-remote": 执行 mcp-remote 代理程序 // "http://localhost:3001/sse?user=[user-id]": Paragon MCP 服务器的 SSE 端点 URL // http://localhost:3001: 请替换为您的 Paragon MCP 服务器的实际域名或 IP 地址和端口 // /sse: 指定使用 SSE 传输协议 // ?user=[user-id]: (仅开发模式) 可选参数,用于在本地开发测试时指定用户 ID,生产环境请移除 }
配置说明:
- 'server name': 为您的 MCP 服务器自定义一个名称,在客户端配置中用于标识不同的 MCP 服务器连接。
- 'command': 指定启动 MCP 服务器代理的命令。这里使用 'npx' 来运行 'mcp-remote' (假定客户端需要一个代理)。
- 'args': 一个字符串数组,包含传递给 'command' 的参数。
- '"mcp-remote"': 假设 'mcp-remote' 是一个客户端代理程序,用于连接到您的 Paragon MCP 服务器。
- '"http://localhost:3001/sse?user=[user-id]"': 这是 Paragon MCP 服务器的 SSE 端点 URL。
- 'http://localhost:3001': 请务必替换为您的 Paragon MCP 服务器实际运行的地址和端口。如果服务器运行在不同的机器或端口,需要修改为相应的地址。
- '/sse': 指定使用 Server-Sent Events (SSE) 协议进行通信,这是 MCP 服务器支持的一种传输方式。
- '?user=[user-id]': 注意:此参数通常仅用于开发和测试环境。 在开发模式下 ('NODE_ENV=development'),您可以将 '[user-id]' 替换为具体的用户 ID,以便在本地测试时模拟特定用户的会话。在生产环境中,请移除 '?user=[user-id]' 参数,并确保客户端通过 'Authorization' header 发送 JWT 进行用户身份验证。
请根据您的 MCP 客户端的具体要求和配置方式,调整上述 JSON 配置。确保客户端能够正确连接到您部署的 Paragon MCP Server。
基本使用方法
- 启动 Paragon MCP Server。
- 配置 MCP 客户端 (如 Cursor, Claude) 连接到该服务器。
- 在 LLM 客户端中,即可使用 Paragon MCP Server 提供的工具,例如调用集成的 SaaS 应用 API 执行操作。
- 当 LLM 需要访问集成应用时,如果用户尚未授权,服务器会返回 Setup Link,引导用户完成授权流程。
信息
分类
开发者工具