项目简介

Memory Journal MCP 服务器是一个专为开发者设计的个人和项目日志系统。它以MCP(Model Context Protocol)服务器的形式运行,为LLM(大型语言模型)客户端提供结构化的上下文信息和丰富的操作功能。通过JSON-RPC协议,LLM客户端可以利用该服务器来记录开发过程、追踪项目进度、构建知识图谱、执行语义搜索,并与Git及GitHub项目无缝集成,从而提升开发效率和上下文理解能力。

主要功能点

  • 日志条目管理: 轻松创建、更新、删除和检索个人或项目相关的日志条目,支持多种日志类型和内容。
  • 三层搜索系统: 提供全文搜索(FTS5)、日期范围搜索和基于ML的语义搜索,帮助用户快速定位信息。
  • 关系与知识图谱: 建立日志条目间的自定义关系(如“引用”、“实现”、“澄清”),并生成Mermaid图表进行可视化展示,构建个人知识网络。
  • Git与GitHub集成: 自动捕获当前Git仓库上下文(分支、最新提交),并深度集成GitHub Projects,支持用户和组织级别项目,提供项目详情、活跃事项和活动时间线。
  • 数据分析与统计: 生成日志统计报告,包括按类型、标签、时间段的活动分析,并提供跨项目洞察和项目进度跟踪。
  • 工作流提示: 预定义多种工作流提示模板,如生成每日站会总结、回顾报告、周报、目标追踪等,简化LLM交互。
  • 数据导出: 支持将日志数据导出为JSON或Markdown格式,方便数据迁移和管理。

安装步骤

Memory Journal MCP 服务器可以通过两种主要方式安装:

  • 方法一:PyPI 包 (推荐)
    1. 确保已安装 Python 和 pip。
    2. 打开终端,运行安装命令:'pip install memory-journal-mcp'
  • 方法二:Docker (推荐完整功能)
    1. 确保已安装并运行 Docker。
    2. 拉取 Docker 镜像:'docker pull writenotenow/memory-journal-mcp:latest'
    3. 创建一个用于存储数据的本地目录,例如:'mkdir data'

服务器配置 (MCP客户端使用)

MCP客户端需要配置服务器的启动命令。以下是两种安装方式对应的推荐配置信息。请将这些信息添加到您的MCP客户端配置文件(例如 '~/.cursor/mcp.json')中。

  • 使用 PyPI 包的配置: 此配置告诉您的MCP客户端如何启动 'memory-journal-mcp' 程序。
    • 服务器名称: 'memory-journal'
    • 启动命令: 'memory-journal-mcp'
  • 使用 Docker 镜像的配置: 此配置指示您的MCP客户端通过Docker运行 'memory-journal-mcp' 容器,并将本地的 'data' 目录挂载到容器内部,以持久化数据。
    • 服务器名称: 'memory-journal'
    • 启动命令: 'docker'
    • 命令参数: 'run --rm -i -v ./data:/app/data writenotenow/memory-journal-mcp:latest python src/server.py' 请确保在运行MCP客户端的目录中存在 'data' 文件夹,或将 '-v' 参数中的 './data' 替换为实际的数据存储路径。
  • GitHub 集成 (可选): 若要启用GitHub Projects集成功能,请在启动MCP客户端的环境中设置 'GITHUB_TOKEN' 环境变量。对于组织项目,您还可以设置 'GITHUB_ORG_TOKEN' 和 'DEFAULT_ORG' 环境变量。
    • 'GITHUB_TOKEN': 您的GitHub个人访问令牌,需要 'repo' 和 'project' 权限。
    • 'GITHUB_ORG_TOKEN': 针对组织项目的可选GitHub令牌,需要 'repo'、'project' 和 'read:org' 权限。
    • 'DEFAULT_ORG': 可选,当项目所有者不明确时指定的默认组织名称。

基本使用方法

一旦服务器启动并通过MCP客户端连接,您就可以通过LLM客户端调用其提供的工具、访问资源或使用预设的提示模板。

  • 创建日志: 使用 'create_entry' 工具,提供日志内容、类型、标签等,服务器会自动捕获Git/GitHub上下文。
  • 语义搜索: 使用 'semantic_search' 工具,通过自然语言查询查找概念相关的日志。
  • 关系可视化: 访问 'memory://graph/recent' 资源,获取最近日志关系的可视化Mermaid图。
  • 项目时间线: 访问 'memory://projects/{项目编号}/timeline' 资源,查看项目活动的时间线。
  • 站会总结: 调用 'prepare-standup' 提示模板,快速生成每日工作总结。

信息

分类

开发者工具