Mcp Todo

🧱 MCP Todo

这是一个通过 WebSocket 管理任务的 API，具有模块化的命令执行和工具支持，使用 TypeScript 和 SQLite 数据库开发。 专为与人工智能代理集成而设计。

---

▶️ 运行项目

1. 确保提交钩子 (Husky) 具有执行权限：

chmod +x .husky/pre-commit

这确保了在尝试执行 git commit 时，pre-commit 钩子能够正确执行。

2. 启动开发服务器：

npm run dev

通过 ts-node 运行服务器。

3. 验证 Git 仓库是否已正确初始化：

git rev-parse --is-inside-work-tree

用于验证目录是否位于 Git 仓库中 — 这是 Husky 和 lint-staged 等工具正常运行所必需的。

---

🧪 运行测试

npm run test

运行使用 Jest 配置的测试套件。

---

📌 要求

在运行上述命令之前，请确保已安装以下要求：

• Node.js v20 或更高版本
• npm v10 或更高版本
• Git

---

🛠️ 可用脚本

• npm run dev: 以开发模式启动应用程序，支持 TypeScript
• npm run test: 使用 Jest 执行测试
• npm run lint: 运行 ESLint 进行代码分析

---

📋 报告和结果

• ✅ 构建/测试状态： 工作流的最新执行状态通过 GitHub Actions 的徽章显示在仓库顶部。
• 📦 可用工件：
  • build-artifact (📁 ./dist) – 包含构建过程中生成的文件。
  • coverage (📁 ./coverage) – 详细的测试覆盖率报告，可在 coverage/lcov-report/index.html 中查看。
• 🔗 访问工件： 生成的工件可在 Actions 页面 上找到。