关键词

文档管理AI集成Markdown记忆系统Misonote

项目简介

Misonote Markdown AI 连接器是一个关键的桥梁，它使得支持 Model Context Protocol (MCP) 的 AI 编辑器（例如 Cursor）能够直接与您的 Misonote Markdown 文档系统进行深度集成和交互。它充当 MCP 服务器的角色，接收 AI 编辑器发出的请求，并将其转发到底层的 Misonote Markdown 服务器，从而让 AI 能够理解和操作您的文档和个性化记忆。

主要功能点

  • 文档管理: 允许 AI 通过自然语言或工具调用执行创建、读取、更新、删除和列出 Misonote 文档的操作。
  • 智能搜索: 支持 AI 在您的 Misonote 文档库中进行全文、标题或路径的智能搜索，快速找到所需信息。
  • 记忆系统: 提供一个结构化的存储空间，AI 可以用来记录和检索您的个人工作习惯、技术偏好、项目复盘经验和学习洞察，从而提供更个性化的协助。
  • 链接生成: 能够为指定的 Misonote 文档生成可直接在浏览器中访问的在线分享链接。
  • 服务器状态查询: 允许 AI 查询底层 Misonote Markdown 服务器的运行状态和支持的能力。

安装步骤

本项目提供了多种安装方式，推荐使用 Smithery.ai 进行一键部署。

  1. 推荐方式 (Smithery.ai):

    • 访问 Smithery.ai 上的 Misonote MCP Client 页面。
    • 根据页面指引完成配置（主要涉及 Misonote 服务器地址和 API 密钥）。
    • 点击安装，即可自动完成部署和配置。

  2. NPM 全局安装:

    • 打开您的终端或命令行工具。
    • 运行以下命令进行全局安装：'npm install -g misonote-mcp'

  3. 源码安装:

    • 从 GitHub 克隆本项目仓库：'git clone https://github.com/leeguooooo/misonote-mcp-client.git'
    • 进入项目目录：'cd misonote-mcp-client'
    • 安装项目依赖：'npm install'

服务器配置 (在 AI 编辑器中)

MCP 服务器配置需要在您的 AI 编辑器（如 Cursor）的设置界面中完成。您需要添加一项新的 MCP 服务器配置，将该连接器指向编辑器。

配置项通常包括：

  • 服务器名称 (Name): 给您的 Misonote 连接器起一个方便识别的名称，例如 'misonote'。
  • 命令 (Command): 指定启动该连接器的命令。
    • 如果您通过 NPM 全局安装，命令通常是 'misonote-mcp'。
    • 如果您通过 源码安装，命令通常是 'node /path/to/your/cloned/repo/misonote-mcp-client/misonote-mcp-client.js'（请将 '/path/to/your/cloned/repo' 替换为实际的项目路径）。
  • 环境变量 (Environment Variables): 在该配置项的环境变量部分，您必须设置两个关键的环境变量：
    • 'MCP_SERVER_URL': 您的 Misonote Markdown 服务器运行的地址，例如 'http://localhost:3000' 或您的实际部署地址。
    • 'MCP_API_KEY': 您在 Misonote Markdown 服务器管理界面中生成的 API 密钥（以 'mcp_' 开头）。这是连接器访问 Misonote 服务器进行身份验证所需的。

完成配置后，AI 编辑器即可通过此配置与 Misonote 连接器建立 MCP 连接。

基本使用方法

安装和配置成功后，您就可以在 AI 编辑器中直接通过自然语言或编辑器提供的工具调用界面与您的 Misonote 文档和记忆进行交互了。

  • 创建文档: 对 AI 说 "请帮我在 projects/my-project 目录下创建一个名为 meeting-notes.md 的文档，内容是..."
  • 获取文档: 对 AI 说 "请获取路径为 documentation/setup-guide.md 的文档内容。"
  • 搜索文档: 对 AI 说 "搜索我的文档，查找所有关于 'Docker' 的内容。"
  • 添加记忆: 对 AI 说 "记录我的一个习惯：我偏好在写 React 时使用函数组件而不是类组件。"（此记忆会被添加到默认项目的 'preferences' 类型下）
  • 获取记忆: 对 AI 说 "列出我的所有习惯记忆。"

AI 会根据您的指令调用相应的工具，并返回操作结果。

获取 API 密钥

您需要先运行 Misonote Markdown 服务器，并通过其管理界面生成用于此连接器的 API 密钥。

  1. 启动 Misonote Markdown 服务器。
  2. 访问服务器的管理界面（通常是 'http://localhost:3000/admin'）。
  3. 登录管理员账号。
  4. 在 API 密钥管理页面创建新密钥，并赋予必要的权限（建议包含 'read', 'write', 'mcp' 权限）。
  5. 复制生成的 API 密钥，并将其配置到 AI 编辑器的环境变量 'MCP_API_KEY' 中。

信息

分类

生产力应用

访问项目