使用说明

项目简介

Task Planner MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,它作为一个任务管理工具,可以与支持 MCP 协议的 AI 客户端(如 Claude)集成。通过此服务器,AI 助手可以创建、更新、删除、查询和管理用户的任务,实现更智能的任务规划和执行。

主要功能点

  • 任务管理: 创建、更新、删除和完成任务。
  • 子任务: 支持将复杂任务分解为多个子任务,方便分步执行和管理。
  • 任务详情: 查看任务的详细信息,包括标题、描述、状态、优先级、创建和更新时间。
  • 任务列表: 列出所有任务或特定父任务的子任务,支持层级查看。
  • 任务优先级: 设置任务的优先级(低、中、高),帮助用户和 AI 助手区分任务的重要程度。
  • 任务分解: 支持将一个父任务分解为多个子任务,方便用户进行更细粒度的任务规划。

安装步骤

  1. 克隆仓库

    git clone https://github.com/CaptainCrouton89/planner.git
    cd planner
  2. 安装依赖 确保你已经安装了 pnpm。如果没有安装,请先安装 pnpm

    pnpm install
  3. 构建项目

    pnpm run build

服务器配置

要将 Task Planner MCP Server 与 MCP 客户端(例如 Claude Desktop)集成,你需要在客户端的配置文件中添加 MCP 服务器的配置信息。

以 'claude_desktop_config.json' 为例,你需要配置 'mcpServers' 字段,添加一个名为 'task-planner' 的服务器配置。

{
  "mcpServers": {
    "task-planner": {
      "command": "node",
      "args": ["/absolute/path/to/planner/build/index.js"]
    }
  }
}

配置参数说明:

  • server name (task-planner): 服务器名称,可以自定义,用于在客户端中标识和引用该服务器。
  • command (node): 启动服务器的命令,这里使用 'node' 来运行 JavaScript 代码。
  • args (["/absolute/path/to/planner/build/index.js"]): 启动服务器命令的参数,指向 'build/index.js' 文件的绝对路径。你需要将 '/absolute/path/to/planner' 替换为你本地仓库的绝对路径。

注意: 请务必将 '/absolute/path/to/planner' 替换为 planner 仓库在你的文件系统中的实际绝对路径。

基本使用方法

  1. 启动服务器

    在仓库根目录下运行以下命令启动 Task Planner MCP Server:

    pnpm start

    服务器成功启动后,会在控制台输出 'Task Planner MCP Server running on stdio...' 提示信息。

  2. 在 MCP 客户端中使用

    配置完成后,在你的 MCP 客户端(如 Claude)中,你可以通过自然语言指令调用 Task Planner MCP Server 提供的工具来管理任务。

    以下是一些示例指令,你可以直接在 Claude 中使用:

    • 创建任务: "Create a new task called 'Plan my vacation'"
    • 分解任务: "Break down my vacation planning task into smaller steps"
    • 列出任务: "What tasks do I have pending?"
    • 查看任务详情: "Show me the details of my vacation planning task"
    • 完成任务: "Mark the flight booking subtask as complete"
    • 删除任务: "Delete the task about grocery shopping"

    客户端会将这些指令转换为对 Task Planner MCP Server 工具的调用,服务器会执行相应的操作并返回结果。

数据存储: 任务数据默认存储在项目根目录下的 'tasks.json' 文件中。

信息

分类

生产力应用