使用说明

项目简介

本项目是 iFlytek Workflow MCP Server，一个基于 Model Context Protocol (MCP) 的服务器实现。它允许 LLM 客户端通过 MCP 协议调用预先配置在讯飞星火平台上的工作流。该服务器将讯飞星火平台的工作流能力封装成 MCP 工具，使得 LLM 应用能够方便地利用星火平台强大的工作流引擎来扩展自身的功能，例如执行复杂任务、访问外部数据等。

主要功能点

工作流工具化: 将讯飞星火平台上的工作流注册为 MCP 工具，LLM 客户端可以像调用普通工具一样调用预设的工作流。
灵活的工作流配置: 通过 'config.yaml' 文件配置需要暴露的工作流，可以自定义工作流的名称、描述以及 API Key 等信息。
支持多种工作流节点: 底层讯飞星火工作流平台支持包括基础节点、工具节点、逻辑节点和转换节点等 14 种节点类型，可以构建复杂的工作流程。
多种执行模式: 支持顺序执行、并行执行、循环执行和嵌套执行等多种工作流执行模式，满足不同的业务场景需求。
流式输出: 支持工作流执行过程中的流式输出，可以实时获取工作流的执行结果。

安装步骤

克隆仓库: 将 GitHub 仓库 'https://github.com/iflytek/ifly-workflow-mcp-server' 克隆到本地。

配置 'config.yaml': 在项目根目录下创建或修改 'config.yaml' 文件，配置需要暴露为 MCP 工具的讯飞星火工作流信息。你需要提供工作流的 'flow_id'、自定义的工具 'name' 和 'description'，以及用于认证的 'api_key'。 'api_key' 一般为 'key:secret' 格式。

- flow_id: '你的工作流 flow_id'
  name: '工作流工具名称 (自定义)'
  description: '工作流工具描述 (自定义)'
  api_key: '你的 API Key (key:secret)'

设置环境变量 'CONFIG_PATH': 设置环境变量 'CONFIG_PATH' 指向 'config.yaml' 文件的路径。例如，如果 'config.yaml' 位于 '/path/to/config.yaml'，则设置 'CONFIG_PATH=/path/to/config.yaml'。

运行服务器: 在项目根目录下，使用 Python 运行 'src/mcp_server/server.py' 文件，启动 MCP 服务器。

cd ifly-workflow-mcp-server
export CONFIG_PATH=/path/to/config.yaml  # 替换为你的 config.yaml 路径
python src/mcp_server/server.py

服务器配置

为了让 MCP 客户端（例如 Claude Desktop 或其他 MCP 客户端）连接到 'iFlytek Workflow MCP Server'，你需要在客户端的配置文件中添加服务器配置信息。以下是一个配置示例，你需要根据你的实际情况进行调整：

{
    "mcpServers": {
        "ifly-workflow-mcp-server": {  // 服务器名称，客户端配置中用于标识该服务器
            "command": "python",      // 启动服务器的命令，这里使用 python 解释器
            "args": [                 // 启动命令的参数
                "src/mcp_server/server.py" // 服务器脚本路径
            ],
            "env": {                   // 环境变量
                "CONFIG_PATH": "/path/to/config.yaml" // 指向 config.yaml 文件的路径，需要替换为你的实际路径
            }
        }
    }
}

配置参数说明:

'"ifly-workflow-mcp-server"': MCP 服务器的名称，在客户端中用于引用该服务器。你可以自定义名称。
'"command": "python"': 运行服务器的命令，这里假设你的环境中 'python' 命令可以执行 Python 解释器。
'"args": ["src/mcp_server/server.py"]': 传递给 'python' 命令的参数，指定服务器脚本的路径。请根据你的实际文件结构调整路径。
'"env": {"CONFIG_PATH": "/path/to/config.yaml"}': 设置环境变量 'CONFIG_PATH'，指向你的 'config.yaml' 配置文件路径。请务必将 '/path/to/config.yaml' 替换为你实际的 'config.yaml' 文件路径。

基本使用方法

启动 MCP 服务器: 按照上述步骤运行 'iFlytek Workflow MCP Server'。
配置 MCP 客户端: 在你的 MCP 客户端（如 Claude Desktop）中，添加上述服务器配置信息。确保 'CONFIG_PATH' 指向正确的 'config.yaml' 文件路径。
连接 MCP 服务器: 在 MCP 客户端中连接到 'ifly-workflow-mcp-server'。
调用工作流工具: 客户端连接成功后，你将能够看到 'iFlytek Workflow MCP Server' 提供的工具列表，这些工具对应于你在 'config.yaml' 中配置的讯飞星火工作流。你可以像调用其他 MCP 工具一样，通过工具名称和参数来调用这些工作流工具，从而在 LLM 应用中使用讯飞星火平台的工作流能力。

关键词