使用说明

项目简介

MCP Notes 是一个基于 Model Context Protocol (MCP) 构建的个人知识管理系统。它允许用户通过 Claude Desktop 等 MCP 客户端连接到这个服务器,从而利用 LLM 与个人笔记进行交互,实现知识的记录、组织、回顾和检索。

主要功能点

  • 资源管理: 将用户的本地笔记目录作为 MCP 资源进行管理,允许 LLM 客户端访问和检索笔记内容。支持列出资源、列出资源模板和读取资源内容。
  • 工具集成: 提供一系列实用工具,扩展 LLM 的功能,例如:
    • '/log': 快速记录日常笔记到指定日期的日志文件中。
    • '/rollup': 根据每日日志自动生成包含成就、洞见和待办事项的每日回顾总结。
    • 'write_note': 创建或覆盖指定路径的笔记文件,支持添加标签。
    • 'search_files': 在笔记目录中递归搜索文件,支持模糊匹配和排除模式。
    • 'read_note': 读取指定路径的笔记文件内容。
    • 'read_multiple_notes': 同时读取多个指定路径的笔记文件内容。
    • 'list_directory': 列出指定目录下的文件和子目录。
    • 'create_directory': 在笔记目录下创建新的目录。
    • 'evaluateInsight': 评估洞察的长期价值和意义,辅助判断笔记的保存价值。
  • Prompt 模板: 内置 Prompt 模板,优化 LLM 交互体验,例如:
    • 'idea-smasher' (原名 'is-this-atomic'): 用于分析用户输入的想法是否足够原子化,并提供改进建议,帮助用户创建更易于组织和连接的笔记。
    • 'end-of-day': 用于在每天结束时进行反思和总结,提取有价值的知识和见解。
    • 'system-prompt': 为 LLM 提供系统级指令,设定其作为个人知识管理助手的角色和目标。

安装步骤

  1. 克隆仓库
    git clone [email protected]:markacianfrani/mcp-notes.git
    cd mcp-notes
  2. 安装依赖
    npm install
  3. 构建项目
    npm run build

服务器配置

要将 MCP Notes 服务器连接到 MCP 客户端(例如 Claude Desktop),您需要配置客户端的配置文件。以 Claude Desktop 为例,在 'claude-desktop-config.json' 文件中添加如下配置:

"notes": {
    "serverName": "mcp-notes",
    "command": "node",
    "args": [
        "path/to/this/repo/mcp-notes/dist/index.js", //  指向 mcp-notes 服务器入口文件 (index.js) 的路径
        "path/to/your/notes" //  替换为您的本地笔记存放目录的绝对路径,例如:"/Users/yourname/Documents/Notes"
    ]
}

注意:请将 'path/to/this/repo/mcp-notes' 替换为 mcp-notes 仓库在您本地的实际路径,并将 'path/to/your/notes' 替换为 您希望 MCP Notes 管理的本地笔记目录的实际路径

基本使用方法

  1. 确保 MCP Notes 服务器已成功配置并运行在您的本地环境中。
  2. 启动 MCP 客户端(如 Claude Desktop),客户端将自动连接到 MCP Notes 服务器。
  3. 在客户端中,您可以通过自然语言指令调用 MCP Notes 提供的工具和 Prompt,与您的个人笔记进行交互。例如:
    • 在 Claude Desktop 中输入 '/log 今天完成了一个重要的功能。' 即可将 "今天完成了一个重要的功能。" 记录到今天的日志文件中。
    • 输入 '/rollup' 即可生成今天的每日回顾总结。
    • 使用 'idea-smasher 思考内容' Prompt,即可分析 "思考内容" 是否足够原子化。

具体工具和 Prompt 的使用方法请参考仓库 README.md 文件中的 🧰 Available Tools💡 Available Prompts 章节。

信息

分类

生产力应用