使用说明

项目简介

Notes DB 是一个基于向量嵌入的个人笔记系统，旨在与 Claude Desktop 无缝集成，充当 MCP 服务器。它利用 Gemini API 生成笔记的语义向量，实现强大的语义搜索功能。此外，它还支持标签分类、GitHub 同步备份，帮助用户高效管理和检索个人知识。

主要功能点

笔记记录: 方便快捷地添加带有标题、内容和可选标签的笔记。
语义搜索: 通过自然语言查询，基于语义相似性快速找到相关笔记，无需精确关键词匹配。
标签管理: 使用标签对笔记进行分类和组织，方便按主题检索。
GitHub 同步: 自动将笔记数据库同步到 GitHub 仓库，实现数据备份和版本控制。
Claude Desktop 集成: 作为 MCP 服务器，直接在 Claude Desktop 中管理和搜索笔记。
数据库统计: 提供笔记总数、近期新增笔记、标签使用情况等统计信息。

安装步骤

环境准备:
- 安装 UV 包管理器。
- 安装 Claude Desktop 应用程序。
- 准备 Gemini API 密钥，用于生成笔记向量嵌入。

配置 Claude Desktop:

打开 Claude Desktop 的配置文件 'claude_desktop_config.json' (通常位于用户主目录)。
在 'mcpServers' 字段下添加或修改 'note_taking' 服务器配置。

{
  "mcpServers": {
     "note_taking": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/path/to/your/NoteTaking",  // 替换为 NoteTaking 仓库的绝对路径
        "--with",
        "click-clack",
        "--",
        "click-clack",
        "--mcp",
        "--module-path",
        "/path/to/your/NoteTaking/src" // 替换为 NoteTaking 仓库 src 目录的绝对路径
      ],
      "env": {
        "GEMINI_API_KEY": "your-gemini-api-key-here", // 替换为你的 Gemini API 密钥
        "HOME": "/your/home/directory/" // 替换为你的用户主目录绝对路径，例如：/Users/yourusername (macOS/Linux) 或 C:/Users/YourUsername (Windows)
      }
    }
  }
}

参数说明:

'command': 设置为 'uv'，使用 UV 包管理器运行程序。
'args': 启动参数列表，包括：
- 'run': UV 的运行命令。
- '--directory': 指定 NoteTaking 仓库的根目录。
- '--with click-clack': 使用 click-clack 扩展，使其作为 MCP 服务器运行。
- '--': 分隔 UV 参数和 click-clack 参数。
- 'click-clack': 运行 click-clack 命令。
- '--mcp': 启用 MCP 服务器模式。
- '--module-path': 指定 Python 模块的搜索路径，指向 'src' 目录。
'env': 环境变量设置，包括：
- 'GEMINI_API_KEY': Gemini API 密钥。
- 'HOME': 用户主目录路径，DuckDB 需要此变量来定位向量搜索扩展。

重启 Claude Desktop: 保存配置文件后，重启 Claude Desktop 使配置生效。

基本使用方法

配置完成后，即可在 Claude Desktop 中与 Notes DB 进行交互：

添加笔记: 在 Claude Desktop 中，向 Claude 助手发送指令，例如 "Add a note titled '量子力学' with content '量子力学是研究微观粒子运动规律的物理学分支' and tag it as '物理学'"。
搜索笔记: 向 Claude 助手提问，例如 "Search my notes for information about 黑洞"。Claude 将调用 Notes DB 进行语义搜索并返回结果。
管理笔记: 可以通过 Claude 助手进行更复杂的笔记管理操作，例如按标签查找、查看统计信息等 (具体指令取决于 Claude Desktop 和 Notes DB 的工具实现)。

注意: 首次使用或数据库发生变更后，可能需要手动初始化 Git 仓库和配置远程仓库信息，具体参考仓库 README 文档中 "GitHub Sync for Notes Database" 部分。

关键词

使用说明

项目简介

主要功能点

安装步骤

基本使用方法

信息