使用说明

项目简介

TaskFlow MCP 是一个基于 Model Context Protocol (MCP) 构建的任务管理服务器。它旨在增强AI助手的能力,使其能够将复杂的用户请求分解为结构化的任务、子任务,并管理它们之间的依赖关系和附带的说明。该服务器支持用户审批流程,确保工作流程的清晰和用户控制。

主要功能点

  • 任务管理: 将大型请求分解为可执行的独立任务。
  • 子任务: 在任务下进一步创建更小的执行步骤。
  • 依赖关系: 为任务或请求定义所需的外部依赖(如库、工具)。
  • 笔记: 为请求添加额外的上下文信息、偏好或指南。
  • 用户审批: 在任务完成或整个请求完成时,需要用户确认才能继续。
  • 状态导出: 将任务、子任务、依赖和笔记的当前状态导出为 Markdown, JSON 或 HTML 文件。
  • 与AI助手集成: 通过标准MCP协议(JSON-RPC over Stdio等)与兼容的AI客户端通信。

安装步骤

  1. 先决条件: 确保你的系统安装了 Node.js (v14 或更高版本) 和 npm。
  2. 获取代码: 从GitHub克隆仓库:
    git clone https://github.com/Aekkaratjerasuk/taskflow-mcp.git
  3. 进入目录:
    cd taskflow-mcp
  4. 安装依赖:
    npm install
  5. 启动服务器:
    npm start
    服务器启动后,将监听标准输入/输出(Stdio)进行MCP通信,并在用户主目录下的 'Documents/tasks.json' 文件中保存任务数据(可通过环境变量 'TASK_MANAGER_FILE_PATH' 修改路径)。

服务器配置

MCP客户端需要配置服务器的启动信息才能连接。对于TaskFlow MCP服务器,典型的MCP客户端配置如下:

{
  "name": "taskflow-mcp",
  // 启动TaskFlow MCP服务器的命令
  "command": "npm",
  // 启动命令的参数。对于 npm start,参数通常就是 "start"
  "args": ["start"]
}

将上述JSON配置添加到你的MCP客户端的服务器配置列表中即可。

基本使用方法

TaskFlow MCP 主要通过AI助手调用其提供的工具来使用。核心工作流程通常如下:

  1. 规划任务: AI助手接收用户请求后,调用 'plan_task' 工具将请求分解为一系列结构化的任务(可包含子任务、依赖、笔记),并获取一个唯一的 'requestId'。
  2. 获取下一个任务: AI助手调用 'get_next_task' 工具,传入 'requestId',服务器会返回下一个待完成的任务信息,并显示当前所有任务的进度表格。
  3. 执行任务/子任务: AI助手根据任务描述执行具体工作。如果任务有子任务,AI应先调用 'mark_subtask_done' 工具标记子任务完成。
  4. 标记任务完成: 当一个任务的所有子任务都完成后(或任务本身无子任务),AI调用 'mark_task_done' 工具标记该任务已完成。服务器会再次显示进度表格。
  5. 等待用户审批: 关键步骤。在标记任务完成或所有任务都完成后,AI必须暂停,等待用户确认任务完成或请求完成。服务器工具本身不包含审批操作,这是客户端AI与用户交互并决定是否继续的过程。用户通过对话向AI表达同意后,AI才能继续。
  6. 继续工作: 用户同意后,AI再次调用 'get_next_task' 获取下一个任务,或在所有任务完成后询问用户是否添加新任务(再次调用 'plan_task' 或 'add_tasks_to_request')或结束请求。

AI还可以使用其他工具进行任务列表查询 ('list_requests'), 查看任务详情 ('open_task_details'), 修改/删除任务或子任务 ('update_task', 'delete_task', 'update_subtask', 'delete_subtask'), 添加新的任务到现有请求 ('add_tasks_to_request'), 添加/更新/删除笔记 ('add_note', 'update_note', 'delete_note'), 添加依赖 ('add_dependency'), 或导出任务状态 ('export_task_status')。

信息

分类

AI与计算