Workflows MCP 使用说明

项目简介

Workflows MCP 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在简化和增强大型语言模型（LLM）应用的 Prompt 管理和工具集成。它允许用户通过 YAML 文件定义可复用的工作流，将多个 Prompt 和 MCP 工具组合成强大的复合工具，从而更高效、更可控地利用 LLM 的能力。

主要功能点

工作流编排: 将 Prompt 和 MCP 服务器工具组合成可复用的工作流，通过 YAML 文件轻松编辑、共享和组织。
自定义触发: 通过自定义命令（例如 "进入调试模式"）触发特定的工作流。
灵活的工具策略: 支持顺序执行和情境/动态执行两种工具调用策略。
团队协作: 通过版本控制 YAML 配置文件，方便团队共享和管理最佳实践的 Prompt 和工具使用方式。
预设工作流: 提供开箱即用的预设工作流，涵盖思考、编码和 GitHub 任务等常见场景。
参数注入: 支持在 Prompt 中注入参数，实现 Prompt 的动态定制。
可扩展配置: 支持从多个 YAML 文件加载自定义配置，并与预设配置合并。

安装步骤

Workflows MCP 可以作为 MCP 服务器集成到 MCP 客户端（例如 Cursor 编辑器）中使用。

安装 Workflows MCP 服务器: 在 MCP 客户端中，添加新的 MCP 服务器，并配置启动命令。

npx -y @agentdesk/workflows-mcp@latest

配置自定义工作流 (可选):
- 在项目根目录下创建 '.workflows' 或 '.mcp-workflows' 目录。
- 在该目录下创建 YAML 配置文件 (例如 'my-workflows.yaml')，定义自定义工作流。
- 可以参考仓库 README.md 中的 "Custom Workflow Configs" 部分了解 YAML 配置文件的编写方法。
启动 MCP 服务器: 在 MCP 客户端中启动 Workflows MCP 服务器。

服务器配置

在 MCP 客户端中配置 Workflows MCP 服务器时，需要提供以下 JSON 配置信息。以下是一个 Cursor 编辑器配置示例：

{
  "mcpServers": {
    "workflows-mcp": {
      "command": "npx",
      "args": ["-y", "@agentdesk/workflows-mcp@latest"]
    }
  }
}

配置参数说明:

server name: 'workflows-mcp' (可以自定义服务器名称)
command: 'npx' (Node Package Execute 命令，用于执行 npm 包)
args: '["-y", "@agentdesk/workflows-mcp@latest"]' (传递给 'npx' 的参数)
- '-y': 自动确认安装 npm 包。
- '@agentdesk/workflows-mcp@latest': 指定要安装和运行的 npm 包名称和版本（最新版本）。

可选配置参数:

'--config <config_directory>': 指定自定义工作流配置目录的路径。例如：

{
  "mcpServers": {
    "workflows-mcp": {
      "command": "npx",
      "args": ["-y", "@agentdesk/workflows-mcp@latest", "--config", "/path/to/.workflows"]
    }
  }
}

'/path/to/.workflows': 替换为实际的 '.workflows' 或 '.mcp-workflows' 目录的绝对路径。

'--preset <preset_names>': 指定要加载的预设工作流模式，多个预设模式用逗号分隔。例如加载 'thinking' 和 'coding' 预设：

{
  "mcpServers": {
    "workflows-mcp": {
      "command": "npx",
      "args": ["-y", "@agentdesk/workflows-mcp@latest", "--preset", "thinking,coding"]
    }
  }
}

'thinking,coding': 指定加载 'thinking' 和 'coding' 预设模式。

组合配置示例: 同时使用自定义配置目录和预设模式：

{
  "mcpServers": {
    "workflows-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@agentdesk/workflows-mcp@latest",
        "--config", "/path/to/.workflows",
        "--preset", "thinking,coding"
      ]
    }
  }
}

基本使用方法

在 MCP 客户端中连接 Workflows MCP 服务器: 启动配置好的 Workflows MCP 服务器。
使用工作流工具: 在 MCP 客户端中，可以使用 Workflows MCP 提供的工具，例如在 Cursor 编辑器中，可以通过命令面板或快捷键调用 Workflows MCP 定义的工作流。
根据工作流描述和提示操作: Workflows MCP 会根据定义的工作流和 Prompt，引导用户完成相应的任务。

具体的工作流使用方式取决于 YAML 配置文件中定义的 Prompt 和工具。请参考仓库 README.md 和示例配置文件了解更多细节。

关键词