使用说明
期刊MCP
用于基于任务的工作日志记录和人工智能集成的模型上下文协议(MCP)服务器。
特性
- 基于任务的日志记录 -按任务/问题组织工作,而不仅仅是按时间顺序
- 问题整合 -将任务链接到GitHub问题或Jira票证
- 结构化1对1 -获取会议见解、待办事项和反馈
- 基于时间的视图 -每日和每周活动总结
- 标记系统 -扁平标签结构,便于分类
- 人类可读存储 -所有数据均以JSON和Markdown格式存储
- 搜索和导出 -查找条目并导出为各种格式
- web界面 -通过REST API和计划的web UI查看和编辑日记账分录
安装
-
克隆存储库:
git clone https://github.com/cpuchip/journal-mcp.git cd journal-mcp -
安装依赖项:
go mod tidy -
构建服务器:
go build -o journal-mcp
用法
运行模式
仅限MCP服务器(默认)
./journal-mcp
仅限Web服务器
./journal-mcp --web
# API available at http://localhost:8080/api
# Documentation at http://localhost:8080/api/docs
双模式(MCP+Web)
./journal-mcp --dual
# Both MCP stdio and web server running
配置
日志数据存储在 ~/.journal-mcp/ 具有以下结构:
~/.journal-mcp/
├── tasks/ # Individual task files (JSON)
├── daily/ # Daily activity summaries
├── weekly/ # Weekly summaries
└── one-on-ones/ # 1-on-1 meeting records
MCP工具
任务管理
create_task-使用问题链接创建新任务add_task_entry-在任务中添加带时间戳的条目update_task_entry-修改现有条目get_task-检索完整的任务历史记录list_tasks-列出具有筛选选项的任务update_task_status-更改任务状态(活动/完成/暂停/阻止)
基于时间的视图
get_daily_log-查看特定日期的所有活动get_weekly_log-查看一周的活动
一对一管理
create_one_on_one-记录结构化会议笔记get_one_on_one_history-检索会议历史记录
搜索和导出
search_entries-搜索所有期刊内容export_data-导出为JSON、Markdown或CSV
GitHub集成
sync_with_github-将分配的GitHub问题与任务同步pull_issue_updates-从GitHub问题中提取最新评论和事件create_task_from_github_issue-从GitHub问题URL创建任务
数据管理
create_data_backup-创建全面的数据备份restore_data_backup-从备份文件还原get_configuration-获取当前配置update_configuration-更新系统配置migrate_data-数据迁移框架(未来SQLite支持)
任务类型
- 工作 -常规工作任务和错误修复
- 学习 -技能发展和研究项目
- 个人的 -个人项目和兼职
- 调查 -研究和勘探任务
工作流示例
-
开始新任务:
{ "id": "MDU-1450", "title": "Fix payment timeout issues", "type": "work", "tags": ["api", "debugging", "payment"], "issue_url": "https://github.com/company/repo/issues/1450", "priority": "high" } -
全天添加工作条目:
{ "timestamp": "2025-09-05T14:30:00Z", "content": "Started investigation - customer reports 8s timeouts in payment flow" } -
完成时更新状态:
{ "status": "completed", "reason": "Fixed database query optimization, reduced to 200ms" }
第3阶段功能(新增!)
增强的GitHub集成
- 自动同步 已分配GitHub问题
- 双向更新 -问题状态更改更新任务
- 评论整合 -将问题注释作为任务条目提取
- 事件跟踪 -跟踪标签、分配和状态更改
Web界面基础
- 完整的REST API 适用于所有MCP功能
- 实时更新 通过WebSocket
- CORS支持 用于前端开发
- OpenAPI文档 在
/api/docs
数据管理
- 备份还原 ZIP压缩
- 配置管理 支持YAML
- 迁移框架 用于未来的数据库支持
- 数据完整性 验证和版本控制
看 第3阶段_食品有限公司 以获取完整的文档。
人工智能集成
此MCP旨在与AI编码助手配合使用,以:
- 自动记录工作 -AI可以在您工作时创建条目
- 建议任务 -基于模式和优先级
- 生成摘要 -用于每日站立或评论
- 跟踪学习 -监控技能随时间的发展
- 1对1准备 -表面相关更新和拦截器
- GitHub自动化 -根据分配的问题自动创建任务
发展
先决条件
- 转到1.21+
- Git
建筑
go build -o journal-mcp
测试
go test ./...
贡献
- 分叉存储库
- 创建要素分支
- 进行更改
- 如果适用,添加测试
- 提交拉取请求
许可证
MIT许可证-有关详细信息,请参阅许可证文件
