tododebt

Name: tododebt
Author: CloudCorpRecords

本地服务

github.com/CloudCorpRecords开发工具01 周前更新

代码仓库

关于 tododebt

tododebt 会扫描指定源码中的 TODO、FIXME 和 HACK 等标记，并汇总位置与数量。它提供命令行工具和 MCP 服务；MCP 工具只处理输入的文件内容，不访问磁盘。

主要功能

01扫描 TODO、FIXME、HACK 标记
02报告文件、行号和文本
03按标记及文件统计数量
04可自定义扫描标记

适用场景

01盘点代码库中已记录的技术债
02在指定源码文件中查找待办事项

MCP 相关

MCP 服务提供 scan_todos 工具，接收包含路径和内容的文件数组，并返回债务标记清单；不读取磁盘。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置

{
  "mcpServers": {
    "cloudcorprecords-tododebt": {
      "command": "npx",
      "args": [
        "-y",
        "@reneturcios/tododebt"
      ]
    }
  }
}

启动命令npx -y @reneturcios/tododebt

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包

npm@reneturcios/tododebt0.1.0stdio

ocighcr.io/cloudcorprecords/tododebt:0.1.0stdio

工具

收录的工具列表 · 更新于 2 周前

参数	类型	必填	说明
path	string	是	要检查的目标路径

详细介绍

tododebt

代码库中积累了多少已知债务？ tododebt 会盘点一组源文件中的标记——默认包括 TODO、FIXME、HACK——并报告每个匹配项的文件、从 1 开始的行号和行文本，以及总数、按标记分类的数量和按文件分类的数量。

标记只有作为独立词元时才会被计数（标记后面必须是非字母字符），因此 TODOS 和 METHOD 不会产生误报，而 TODO:、FIXME(user) 和 // TODO 都会被计数。每行只报告第一个标记。匹配区分大小写。

MCP 工具将文件内容作为输入（不访问磁盘）；CLI 会读取你指定的文件。纯本地计算：无需网络，也无需配置。

CLI

npx @reneturcios/tododebt scan src/*.ts
npx @reneturcios/tododebt scan README.md src/index.ts --markers TODO,XXX
npx @reneturcios/tododebt --version

退出代码：成功时为 0（非空盘点结果属于结果，不属于错误），运行时错误（包括无法读取文件）时为 1，用法错误时为 2。

MCP 服务

npx -y @reneturcios/tododebt mcp

MCP 客户端配置：

{
  "mcpServers": {
    "tododebt": {
      "command": "npx",
      "args": ["-y", "@reneturcios/tododebt", "mcp"]
    }
  }
}

工具

scan_todos — 盘点所提供源文件中的债务标记。
- files（数组，必填）— 要扫描的文件，格式为 {path, content} 键值对
- markers（字符串数组，可选）— 要查找的标记；默认为 TODO、FIXME、HACK

Docker

docker run -i ghcr.io/cloudcorprecords/tododebt
docker run --rm -v "$PWD:/w" ghcr.io/cloudcorprecords/tododebt scan /w/src/index.ts

开发

npm install
npm run build   # tsc -> dist/
npm test        # tsx --test test/*.test.ts (pure local, no network)
npm run dev     # run the CLI from source