JinDaGe - devrecord MCP Details

article

README

🚀 DevRecord MCP 服务器

DevRecord MCP 服务器是一款专门用于记录和整理对话内容的工具，它遵循 MCP (Model Context Protocol) 协议，提供模板化的记录功能，能帮助用户高效地完成各类记录工作。

🚀 快速开始

克隆项目

git clone https://github.com/seenbefore/DevRecord.git
cd DevRecord

安装依赖

需要 node 版本 16+，推荐使用 18 版本。

npm install

构建项目

npm run build

在 mcp_client 中使用

{
  "mcpServers": {
    "devrecord": {
      "command": "node",
      "args": ["C:\\PATH\\TO\\PARENT\\FOLDER\\DevRecord\\build\\index.js"]
    }
  }
}

当您对大模型说："用 devrecord 帮我记录一下"，大模型会执行以下步骤：

调用 get_template_list 获取可用模板列表。
根据对话内容选择合适的模板。
调用 get_template_detail 获取模板详情。
按照模板规范总结对话内容。
生成 markdown 文档并保存到 src/record/ 目录。

✨ 主要特性

🔧 两个核心工具

get_template_list：获取可用的记录模板列表。
get_template_detail：获取具体模板的详细内容。

📝 内置模板

会议记录模板 (meeting-record)：用于记录会议内容、决策和行动项。
项目总结模板 (project-summary)：用于总结项目进展、问题和计划。
学习笔记模板 (learning-notes)：用于记录学习内容和心得体会。
每日站会模板 (daily-standup)：用于记录团队每日站会内容。

💻 使用示例

基础用法

在 mcp_client 中按照上述配置使用 DevRecord MCP 服务器，即可利用其内置模板进行对话内容的记录。

高级用法

如果您需要添加自定义模板，可以按照以下步骤操作：

在 src/template/ 目录下创建新的 .md 文件。
在 src/index.ts 的 getTemplateDescription 函数中添加描述。
重新构建项目。

📚 详细文档

工具说明

get_template_list

描述：获取所有可用的记录模板。
参数：无。
返回：模板列表，包含模板名称、文件名和描述。

get_template_detail

描述：获取指定模板的完整内容。
参数：
- templateName (string)：模板名称（不含扩展名）。
返回：模板的完整 markdown 内容。

目录结构

DevRecord/
├── src/
│   ├── index.ts          # MCP服务器主文件
│   ├── template/         # 模板目录
│   │   ├── meeting-record.md
│   │   ├── project-summary.md
│   │   ├── learning-notes.md
│   │   └── daily-standup.md
│   └── record/           # 生成的记录文档目录
├── build/                # 编译后的文件
├── package.json
└── tsconfig.json

🔧 技术细节

技术栈

TypeScript：用于编写服务器代码，提供类型检查，增强代码的可维护性。
Node.js：作为服务器运行环境，支持跨平台运行。
MCP SDK (@modelcontextprotocol/sdk)：遵循 MCP 协议，实现服务器的核心功能。
Zod (参数验证)：用于验证接口参数，确保数据的准确性。

开发说明

确保安装了 Node.js 和 npm。
使用 TypeScript 进行开发，遵循 MCP 协议规范。
支持跨平台运行（Windows/Linux/macOS）。

📄 许可证

本项目基于 MIT License 开源。欢迎提交 Issue 或 Pull Request 参与项目贡献！

devrecord