待办事项管理服务器

一个用于管理待办事项和任务清单的模型上下文协议(MCP)服务器,提供结构化的工作项跟踪、状态管理和任务依赖关系处理。

  • by rwese
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 rwese/mcp-backlog

使用说明

MCP备份服务器

用于管理待办事项和待办事项的模型上下文协议(MCP)服务器。此服务器提供了一种结构化的方式来跟踪工作项、其状态和相关任务。

特性

  • 待办事项管理:创建、读取、更新和归档待办事项
  • 待办事项跟踪:在有依赖关系的待办事项列表中管理待办事项
  • 状态工作流:按州跟踪项目:新→ 准备→ 审查→ done
  • 优先级:按高、中或低优先级组织项目
  • 版本控制:修改积压项目时自动进行版本控制
  • Markdown存储:带有frontmatter的人类可读标记文件
  • 修剪/清除:删除旧的已完成项目以保持存档干净

安装

快速启动(零安装)

使用NPX(Node.js):

npx -y github:rwese/mcp-backlog

使用Bunx(Bun-更快):

bunx --bun github:rwese/mcp-backlog

全球安装

搭配Bun(推荐):

# From GitHub (latest)
bun add -g github:rwese/mcp-backlog

# From NPM (when published)
bun add -g @rwese/mcp-backlog

与NPM合作:

# From GitHub
npm install -g github:rwese/mcp-backlog

# From NPM (when published)
npm install -g @rwese/mcp-backlog

来源

git clone https://github.com/rwese/mcp-backlog.git
cd mcp-backlog
bun install  # or npm install
bun run build  # or npm run build

用法

在MCP客户端配置中

添加到MCP客户端的配置文件中:

使用GitHub上的NPX(推荐):

{
  "mcpServers": {
    "backlog": {
      "command": "npx",
      "args": ["-y", "github:rwese/mcp-backlog"]
    }
  }
}

使用Bunx(更快):

{
  "mcpServers": {
    "backlog": {
      "command": "bunx",
      "args": ["--bun", "github:rwese/mcp-backlog"]
    }
  }
}

使用全局安装:

{
  "mcpServers": {
    "backlog": {
      "command": "mcp-backlog"
    }
  }
}

使用NPX:

{
  "mcpServers": {
    "backlog": {
      "command": "npx",
      "args": ["@rwese/mcp-backlog"]
    }
  }
}

使用本地构建:

{
  "mcpServers": {
    "backlog": {
      "command": "node",
      "args": ["/path/to/mcp-backlog/dist/index.js"]
    }
  }
}

工具

积压已读

列出并过滤待办事项。

论据:

  • status (可选):按状态筛选(新建、准备就绪、审核、已完成、重新打开、wontfix)
  • priority (可选):按优先级筛选(高、中、低)

积压写作

创建和管理待办事项。

论据:

  • action:要执行的操作(创建、列出、修改、批准、提交、重新打开、wontfix)
  • topic:积压项目的主题名称
  • description:工作项的描述
  • priority (可选):优先级(默认:中等)
  • status (可选):修改操作的状态

示例:

// Create a new backlog item
{
  "action": "create",
  "topic": "Add user authentication",
  "description": "Implement JWT-based authentication",
  "priority": "high"
}

// Amend an existing item
{
  "action": "amend",
  "topic": "Add user authentication",
  "status": "ready"
}

积压已完成

将待办事项标记为已完成。

论据:

  • action:完成或列出
  • topic:要标记为已完成的主题名称
  • summary (可选):完成总结

票已读

列出积压项目的待办事项。

论据:

  • topic:待办事项主题(必填)
  • status (可选):按状态筛选
  • batch (可选):按批次筛选

车票书写

在待办事项列表中创建和更新待办事项。

论据:

  • action:创建、更新或列出
  • topic:待办事项主题(必填)
  • todoId:待办事项ID(用于更新)
  • content:Todo内容
  • status:待办事项状态(待定、正在进行中、已完成、已取消)
  • dependencies:必须首先完成的todo ID数组
  • batch:批次标识符

票已完成

将todos标记为已完成依赖验证。

论据:

  • action:完成或列出
  • topic:待办事项主题(必填)
  • todoId:Todo ID标记为已完成

修剪

从completed_backlog中删除旧的已完成/已存档的待办事项。

论据:

  • action:要执行的操作(列表、修剪、清除)-默认值:列表
  • olderThanDays (可选):对于修剪操作,删除超过此天数的项目(默认值:30)
  • dryRun (可选):预览未实际删除的内容(默认值:false)

示例:

// List all completed items with their age
{
  "action": "list"
}

// Preview what would be deleted (items older than 7 days)
{
  "action": "prune",
  "olderThanDays": 7,
  "dryRun": true
}

// Actually delete items older than 30 days
{
  "action": "prune",
  "olderThanDays": 30
}

// Clear all completed items (with preview first)
{
  "action": "clear",
  "dryRun": true
}

目录结构

默认位置(XDG兼容)

默认情况下,服务器将积压数据存储在具有多项目隔离的XDG兼容目录中:

~/.local/share/mcp-backlog/
└── projects/
    └── <project-name>/
        ├── Backlog/
        │   └── <topic-name>/
        │       ├── item.md       # Backlog item details
        │       └── todos.json    # Associated todos
        └── COMPLETED_Backlog/
            ├── DONE_<topic>-v1.md
            └── WONTFIX_<topic>.md

多项目支持

每个项目都有自己的独立目录:

  • Git仓库:使用存储库根目录名称作为项目标识符
  • 非git项目:使用目录名+哈希值进行唯一性

这允许您在多个项目中使用相同的MCP服务器而不会发生冲突。

传统支持

为了向后兼容性,如果你有一个现有的 .agent/ 在您当前的工作目录中,将使用它来代替XDG目录。

自定义位置

您可以使用环境变量覆盖默认位置:

选项1:设置自定义积压目录

export MCP_BACKLOG_DIR="/path/to/your/backlog"

选项2:设置XDG_DATA_HOME(影响所有符合XDG的应用程序)

export XDG_DATA_HOME="/path/to/data"
# Backlog will be stored at: /path/to/data/mcp-backlog/

将以下内容添加到MCP客户端配置中:

{
  "mcpServers": {
    "backlog": {
      "command": "mcp-backlog",
      "env": {
        "MCP_BACKLOG_DIR": "/custom/path"
      }
    }
  }
}

配置

看 配置.md 有关以下内容的详细信息:

  • XDG基本目录支持
  • 多项目隔离
  • 环境变量
  • 自定义存储位置
  • 平台特定默认值

发展

运行测试

bun test

构建

bun run build

工作流程

  1. 创建 状态为“新”的待办事项
  2. 提交 将其移动到“就绪”(准备工作)
  3. 修正 工作完成后将状态更新为“审核”
  4. 批准 从“审查”到“完成”
  5. 完成 将已完成的项目存档

或使用 重新开放 将项目退回以进行更多工作,或 不予修复 归档而不完成。

许可证

麻省理工学院