使用说明

项目简介

Notes Server 是一个基于 Model Context Protocol (MCP) 构建的笔记管理服务器。它允许用户通过 MCP 客户端以标准化的方式管理个人笔记,提供了笔记的持久化存储、资源访问、工具调用和 Prompt 模板等功能,使得 LLM 应用可以方便地与个人笔记进行集成和交互。

主要功能点

  • 笔记的CRUD操作: 支持创建、读取、更新和删除笔记。
  • 持久化存储: 使用 JSON 文件 ('notes_storage.json') 持久化存储笔记数据。
  • 资源访问: 通过 'note://' URI 方案将笔记作为资源进行访问,方便 LLM 客户端获取笔记内容。
  • 工具调用: 提供了一系列工具,如 'add-note', 'list-all-notes', 'update-note', 'delete-note',用于管理笔记。
  • Prompt 模板: 内置 'summarize-notes' Prompt 模板,支持对笔记进行总结。

安装步骤

  1. 环境准备: 确保已安装 Python 3.10 或更高版本。
  2. 创建虚拟环境: 打开终端,导航到您希望存放项目的目录,并执行以下命令创建虚拟环境:
    python -m venv .venv
  3. 激活虚拟环境:
    • Unix/MacOS:
      source .venv/bin/activate
    • Windows:
      .venv\Scripts\activate
  4. 安装依赖: 在虚拟环境中,执行以下命令安装 'MCP' 库:
    pip install MCP
  5. 安装 Notes Server: 使用 'mcp' 命令行工具安装 Notes Server。假设您已将仓库克隆到本地的 'mcp-notes' 目录,请执行:
    mcp install mcp-notes/src/notes

服务器配置

要将 Notes Server 与 MCP 客户端(如 Claude Desktop)连接,您需要提供以下服务器配置信息。这些信息通常配置在 MCP 客户端的服务器设置中。

{
  "server_name": "Notes",  // 服务器名称,与 server.py 中 Server("Notes") 的名称一致
  "command": "mcp",        // 启动服务器的命令,这里使用 mcp 命令行工具
  "args": [               // 启动服务器的参数
    "start",              // mcp start 命令用于启动指定的 MCP 服务器
    "Notes"               // 服务器实例名称,与 mcp install 时指定的名称一致
  ],
  "description": "Notes MCP Server for managing personal notes." // 服务器描述,可选
}

基本使用方法

  1. 启动服务器: 在终端中执行以下命令启动 Notes Server:
    mcp start Notes
    服务器将在后台运行,并通过标准输入/输出 (stdio) 与 MCP 客户端通信。
  2. 连接客户端: 在 MCP 客户端中配置上述服务器配置信息,客户端将自动连接到 Notes Server。
  3. 使用工具: 通过 MCP 客户端调用 Notes Server 提供的工具来管理笔记,例如:
    • 'add-note': 创建新笔记,需要提供 'name' (笔记名称) 和 'content' (笔记内容) 参数。
    • 'list-all-notes': 列出所有笔记,无需参数。
    • 'update-note': 更新现有笔记,需要提供 'name' (笔记名称) 和 'content' (新笔记内容) 参数。
    • 'delete-note': 删除笔记,需要提供 'name' (笔记名称) 参数。
  4. 使用 Prompt: 通过 MCP 客户端调用 'summarize-notes' Prompt 模板来总结笔记,可以选择 'style' 参数 (brief/detailed) 控制总结风格。
  5. 访问资源: 在支持资源访问的 MCP 客户端中,可以使用 'note://internal/笔记名称' 的 URI 访问特定笔记的内容。

信息

分类

生产力应用