使用说明

项目简介

Notes MCP 是一个基于 Model Context Protocol (MCP) 的服务器应用。它作为一个后端服务,使支持 MCP 协议的 LLM (大型语言模型) 客户端能够与您 macOS 上的 Apple 备忘录进行交互。通过定义一系列可调用的工具 (Tools),Notes MCP 允许 LLM 智能地访问、创建、查询和管理您的备忘录数据,将您的个人知识库融入到 LLM 的工作流程中。

主要功能点

  • 与 LLM 客户端通信: 使用 Model Context Protocol (MCP) 通过标准输入/输出 (Stdio) 与兼容的 LLM 客户端建立连接并交换数据。
  • 提供备忘录工具: 暴露一系列工具供 LLM 调用,实现对 Apple 备忘录的具体操作。
  • 获取备忘录信息: 支持检索所有备忘录文件夹、获取指定文件夹内的备忘录列表、按唯一标识符或标题查询单个备忘录详情。
  • 创建新备忘录: 允许 LLM 在指定的备忘录文件夹中创建新的备忘录,包括标题和内容。
  • 统计功能: 提供获取 Apple 备忘录总数的功能。
  • macOS原生交互: 利用 macOS 的自动化能力与 Apple 备忘录应用直接通信。

安装步骤

在开始安装 Notes MCP 之前,请确保您的系统满足以下要求:

  • 运行 macOS 10.15 或更高版本。
  • 已安装 Apple 备忘录应用。
  • 已安装 Node.js 运行时环境。

请按照以下步骤安装和启动服务器:

  1. 下载代码: 从项目的 Releases 页面下载最新版本的源代码包。
  2. 解压并导航: 将下载的文件解压到您选择的目录,并在终端中进入该目录。
  3. 安装依赖: 在终端中运行以下命令安装项目所需的依赖库:
    npm install
  4. 启动服务器: 依赖安装完成后,运行以下命令启动 Notes MCP 服务器:
    npm start
    服务器将启动并等待 MCP 客户端通过标准输入/输出连接。

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

Notes MCP 服务器通过标准输入/输出 (Stdio) 与 MCP 客户端通信。要让您的 LLM 客户端连接并使用此服务器,您需要在客户端的 MCP 服务器配置中指定如何启动这个服务器进程。通常,这包括服务器的名称、启动命令及其参数。

您需要在您的 MCP 客户端中添加一个服务器配置项,指定启动 Notes MCP 服务器的命令。典型的配置会包含类似以下的信息:

  • 名称 (name): 一个标识服务器的名称,例如 "Apple Notes MCP"。
  • 命令 (command): 执行服务器程序的命令,通常是 'node'。
  • 参数 (args): 传递给命令的参数,即服务器入口文件的路径。根据项目的结构,入口文件通常位于构建后的 'dist' 目录中,例如 'dist/index.js'。您需要提供这个文件的正确路径。请注意,这个路径可能是相对路径(如果客户端从项目根目录启动)或绝对路径(推荐,例如 '/path/to/your/notes-mcp/dist/index.js')。

请根据您的 MCP 客户端的具体配置方式,填写这些信息。

基本使用方法

Notes MCP 服务器启动后,它不提供直接的图形界面或网页接口供用户手动操作。它是一个纯粹的后端服务,专为 MCP 兼容的 LLM 客户端设计。

要使用此服务器,您需要:

  1. 启动 Notes MCP 服务器(如安装步骤所述)。
  2. 在您的 MCP 兼容 LLM 客户端中,配置并连接到 Notes MCP 服务器(如服务器配置所述)。
  3. 一旦连接成功,LLM 客户端将能够发现 Notes MCP 服务器提供的工具(如获取备忘录、创建备忘录等)。
  4. 您可以通过与 LLM 交互,让 LLM 调用这些工具来访问或修改您的 Apple 备忘录。例如,您可以让 LLM“查找关于会议纪要的备忘录”或“在工作文件夹中创建一个新备忘录”。

信息

分类

生产力应用