使用说明

项目简介

Workflows MCP 是一款 Model Context Protocol (MCP) 服务器,旨在帮助用户更高效地管理和使用 Prompt 以及各种 MCP 工具。它允许您将 Prompt 和 MCP 服务器组合成可重用的工作流,并通过 YAML 文件轻松共享和版本控制这些工作流。Workflows MCP 的目标是将 Prompt 变成可编程的工具和规则,提高 AI 在代码编辑器中的确定性,并减少跨请求的 Token 使用量。

主要功能点

  • 工作流编排: 将 Prompt 与 MCP 服务器组合成可重用的工作流,方便编辑、共享和组织。
  • 自定义命令触发: 通过自定义命令(如 "进入调试模式" 或 "使用思考模式")触发工作流。
  • 灵活的工具策略: 支持定义工作流中工具的使用策略,包括顺序执行和情境/动态执行。
  • 团队协作: 通过版本控制轻松地在团队中共享和管理最佳 Prompt 和 MCP 工具使用方式。
  • 预设工作流: 提供多种预设工作流模式,如思考模式、编码模式和 GitHub 模式,方便快速上手。
  • 参数注入: 支持在 Prompt 模板中使用参数,实现更灵活的 Prompt 定制。
  • 自定义配置: 支持从 YAML 文件加载自定义配置,并支持从多个 YAML 文件加载配置。

安装步骤

  1. 安装 Workflows MCP 服务器: 在 MCP 客户端中,使用以下命令或 JSON 配置安装 Workflows MCP 服务器:

    npx -y @agentdesk/workflows-mcp@latest

    或在 MCP 客户端的 JSON 配置文件中添加以下配置:

  2. 自定义配置 (可选):

    • 创建配置目录: 在您的项目根目录下创建 '.workflows' 或 '.mcp-workflows' 目录。
    • 添加 YAML 配置文件: 在配置目录中添加 YAML 配置文件(文件名以 '.yaml' 或 '.yml' 结尾)。您可以在这些文件中定义自定义工作流和工具配置。
    • 指定配置目录: 如果您创建了自定义配置目录,可以使用 '--config' 标志指定配置目录的路径启动 Workflows MCP 服务器,例如:
      npx @agentdesk/workflows-mcp@latest --config /path/to/.workflows
    • 加载预设 (可选): 如果您希望加载预设工作流模式(如思考、编码、GitHub),可以使用 '--preset' 标志指定要加载的预设,例如:
      npx @agentdesk/workflows-mcp@latest --preset thinking,coding,github
    • 组合配置: 您可以同时使用 '--config' 和 '--preset' 标志,例如:
      npx @agentdesk/workflows-mcp@latest --config /path/to/.workflows --preset thinking,coding

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令及其参数才能连接到 Workflows MCP 服务器。以下是一个 Cursor 编辑器中配置 Workflows MCP 服务器的 JSON 示例,您可以根据您的 MCP 客户端进行相应的配置:

{
  "mcpServers": {
    "workflows-mcp": {  // 服务器名称,可以自定义
      "command": "npx",  // 启动服务器的命令,这里使用 npx 执行 npm 包
      "args": [         // 传递给命令的参数
        "-y",           // npx 参数,自动确认安装包
        "@agentdesk/workflows-mcp@latest" // 要执行的 npm 包,即 Workflows MCP 服务器
      ]
    }
  }
}

如果您需要使用自定义配置和预设,可以修改 'args' 数组,例如:

{
  "mcpServers": {
    "workflows-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@agentdesk/workflows-mcp@latest",
        "--config", "/path/to/.workflows",  // 指定自定义配置目录
        "--preset", "thinking,coding"       // 加载 thinking 和 coding 预设
      ]
    }
  }
}

基本使用方法

  1. 启动 MCP 客户端: 启动您使用的 MCP 客户端(如 Cursor 编辑器)。
  2. 配置 MCP 服务器: 在 MCP 客户端的设置中配置 Workflows MCP 服务器,填入上述 JSON 配置信息。
  3. 连接 MCP 服务器: 客户端会自动连接到 Workflows MCP 服务器。
  4. 使用工作流和工具: 在 MCP 客户端中,您可以像使用其他 MCP 服务器一样,调用 Workflows MCP 服务器提供的工具和工作流,例如在 Cursor 编辑器中,您可以使用 '@workflows-mcp/工作流名称' 的方式来触发定义好的工作流。具体的工作流和工具取决于您加载的预设和自定义配置。

注意:

  • 更新配置后,您可能需要在 MCP 客户端中刷新 MCP 工具或重启客户端以使配置生效。
  • 如果遇到问题,请检查 YAML 配置文件是否有效,并尝试移除并重新添加 MCP 工具。

信息

分类

开发者工具