使用说明

项目简介

YepCode MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,它桥接了 AI 平台和 YepCode 基础设施。通过此服务器,您可以轻松地将您的 YepCode 流程转换为 AI 可以直接调用的工具,从而实现 AI 应用与后端工作流的深度整合。

主要功能点

  • 零配置工具转换: 将 YepCode 流程自动转换为 AI 可用的 MCP 工具。
  • 实时工作流控制: 实现 AI 系统对后端 YepCode 工作流的直接控制和交互。
  • 企业级安全环境: 在 YepCode 隔离且生产就绪的环境中安全执行代码和流程。
  • 广泛兼容性: 与任何支持 Model Context Protocol 的 AI 平台无缝集成。
  • 核心工具集: 提供代码执行、环境变量管理和 YepCode 流程执行等核心工具,满足 AI 应用的各种后端需求。

安装步骤

YepCode MCP Server 以 npm 包 '@yepcode/mcp-server' 的形式发布,无需额外的安装步骤。您可以直接通过 NPX 或 Docker 运行该服务器。

服务器配置

为了让 MCP 客户端(如 Cursor 或 Claude)连接到 YepCode MCP Server,您需要在客户端配置中指定服务器的启动命令和参数。以下是使用 NPX 和 Docker 的配置示例:

使用 NPX

{
  "mcpServers": {
    "yepcode-mcp-server": {
      "command": "npx",
      "args": ["-y", "@yepcode/mcp-server"],
      "env": {
        "YEPCODE_API_TOKEN": "YOUR_YEPCODE_API_TOKEN",  // 请替换为您的 YepCode API Token
        "YEPCODE_PROCESSES_AS_MCP_TOOLS": "true"       // 可选,设置为 "true" 以启用 YepCode 流程作为 MCP 工具
      }
    }
  }
}

使用 Docker

{
  "mcpServers": {
    "yepcode-mcp-server": {
      "command": "docker",
      "args": [
        "run",
        "-d",
        "-e",
        "YEPCODE_API_TOKEN=YOUR_YEPCODE_API_TOKEN",  // 请替换为您的 YepCode API Token
        "-e",
        "YEPCODE_PROCESSES_AS_MCP_TOOLS=true",       // 可选,设置为 "true" 以启用 YepCode 流程作为 MCP 工具
        "yepcode/mcp-server"
      ]
    }
  }
}

配置参数说明:

  • 'command': 启动 MCP 服务器的命令,根据您选择的运行方式,可以是 'npx' 或 'docker'。
  • 'args': 'command' 命令的参数,用于指定要执行的 MCP 服务器。
  • 'env': 环境变量配置,用于向服务器传递必要的配置信息:
    • 'YEPCODE_API_TOKEN': 必需。您的 YepCode API Token,用于服务器安全地访问您的 YepCode 账户。您可以在 YepCode Cloud 控制台的 "Settings" -> "API credentials" 中获取。
    • 'YEPCODE_PROCESSES_AS_MCP_TOOLS': 可选。设置为 '"true"' 时,服务器会将您在 YepCode 中创建的流程作为独立的 MCP 工具暴露出来,使 AI 客户端可以直接调用这些流程。

基本使用方法

配置完成后,MCP 客户端即可通过 JSON-RPC 协议与 YepCode MCP Server 建立连接。客户端可以发送 MCP 请求,例如:

  1. 列出可用工具: 客户端可以请求服务器提供所有可用的工具列表,包括内置工具(如 'run_code', 'set_env_var')以及您在 YepCode 中定义的流程(如果启用了 'YEPCODE_PROCESSES_AS_MCP_TOOLS')。
  2. 调用工具: 客户端可以根据工具的名称和参数,发送 'tools/call' 请求来调用特定的工具。例如,调用 'run_code' 工具可以在 YepCode 的安全环境中执行代码,并返回执行结果和日志。调用 'run_yepcode_process_<process_slug>' 工具可以触发执行您预先定义的 YepCode 流程。

通过 YepCode MCP Server,AI 平台可以安全、高效地利用 YepCode 的后端能力,构建功能强大的 AI 应用。

信息

分类

AI与计算