RemNote自动化桥接服务器

连接AI代理与RemNote知识库的MCP协议服务器,支持通过命令行工具和HTTP接口操作笔记、闪卡及搜索功能

  • by robert7
  • TypeScript
  • 本地部署
  • 30 星标
  • 更新于
在 GitHub 查看 robert7/remnote-mcp-server

使用说明

RemNote MCP服务器

MCP服务器和CLI包,将AI代理、本地脚本和编码线束连接到 RemNote 通过 RemNote自动化桥 插件.

连接问题?请先检查RemNote桥接插件和服务器版本。 使用官方 MCP/OpenClaw自动化桥 由Robert Spiegel在RemNote中创建,并运行兼容的 remnote-mcp-server 在同一方面 0.x 小线。错误的插件风格或不匹配的版本可能会与 1008 兼容性消息。 如果Marketplace和npm发布暂时停止 同步、固定匹配的服务器包或从源代码运行匹配的网桥/服务器签出。从 版本兼容性指南, 插件安装指南, 本地插件指南,以及 服务器安装指南. 设置后,请参阅 代理验证提示 验证您选择的AI 代理可以端到端地使用已安装的RemNote MCP工具。 如果指南没有解决您的问题, 打开一个问题 随着 相关版本、设置路径、观察到的行为和确切的错误/状态消息。

这是什么?

RemNote MCP服务器使Claude Code等AI助手能够直接与您的RemNote知识库进行交互 通过模型上下文协议(MCP)。同样的npm包也提供了 remnote-cli,命令行MCP客户端 用于本地脚本和编码工具,以及 remnote-mcp-stdio,用于无法使用的客户端的stdio MCP代理 直接流式传输HTTP。创建笔记、分层标记树和RemNote原生抽认卡;搜索并阅读 你的知识库;更新现有笔记;并通过MCP工具或shell命令维护您的日常日志。 查看AI代理示例 备注: 演示和截图 · 高级用例

双组件架构

该系统由以下部分组成 两个独立的运行时组件 协同工作:

  1. RemNote自动化桥 -一个在你的电脑上运行的RemNote插件 浏览器或RemNote桌面应用程序,并通过WebSocket公开RemNote API功能
  2. RemNote MCP服务器 (此项目)-一个独立的服务器包,提供 remnote-mcp-server 对于MCP HTTP客户端, remnote-mcp-stdio 对于stdio MCP客户端,以及 remnote-cli 用于命令行工作流

这个 remnote-cli 和 remnote-mcp-stdio 命令不是第二个面向RemNote的服务器。他们称之为MCP端点 由...暴露 remnote-mcp-server.

对于OpenClaw/Hemis AI代理和其他命令驱动的本地自动化, remnote-cli 是直接路径:指向 代理商在捆绑 RemNote CLI技能 并保持MCP服务器在本地运行。

对于详细的网桥连接生命周期、重试阶段和唤醒触发器,请使用网桥仓库作为 真相: 连接生命周期指南.

运作原理

AI agents (HTTP) -> MCP HTTP Server :3001 -> WebSocket Server :3002 -> RemNote Plugin -> RemNote
AI agents (stdio) -> remnote-mcp-stdio -> MCP HTTP Server :3001 -> WebSocket Server :3002 -> RemNote Plugin -> RemNote
CLI commands -> remnote-cli -> MCP HTTP Server :3001 -> WebSocket Server :3002 -> RemNote Plugin -> RemNote

服务器充当桥梁:

  • 通过流式HTTP传输(MCP协议)与AI代理通信-支持本地和远程访问
  • 提供 remnote-mcp-stdio 作为需要stdio传输的客户端的本地stdio MCP代理
  • 提供 remnote-cli 作为本地自动化的捆绑命令行MCP客户端
  • HTTP服务器(端口3001)管理多个并发代理的MCP会话
  • WebSocket服务器(端口3002)连接到RemNote浏览器插件
  • 将MCP工具调用转换为RemNote API操作

多代理支持: 多个AI代理可以同时连接到同一个RemNote知识库。每个代理 在共享WebSocket网桥的同时获得自己的MCP会话。

远程访问: 默认情况下,服务器绑定到本地AI代理的localhost(127.0.0.1)。克劳德桌面和克劳德 启用桌面扩展后,Cowork可以使用捆绑的本地MCPB扩展。基于云的客户端,网络/移动 在没有本地MCPB的情况下,表面和受管理的Claude部署需要远程访问——使用ngrok等隧道工具 安全地公开HTTP端点。为了安全起见,WebSocket连接始终保持在本地。看 远程访问指南 用于设置。

特性

  • 创建笔记和抽认卡 -创建简单的笔记、层次化的标记树或RemNote原生抽认卡
  • 搜索知识库 -使用祖先上下文运行全文搜索或精确标记Rem ID搜索
  • 阅读笔记 -使用可配置的遍历深度以markdown或结构化形式检索笔记内容
  • 更新备注 -修改标题,插入或替换分层内容,并通过精确的Rem ID管理标签
  • 日记账分录 -为带有时间戳的每日条目添加分层标记内容和可选的精确标签Rem ID
  • 代理手册 -为MCP客户端返回内置导航和安全指南
  • 连接状态 -检查服务器和插件连接健康状况

快速开始

1.安装服务器

版本兼容性(0.x 森伯: 安装a remnote-mcp-server 版本与您安装的RemNote Automation Bridge插件版本兼容。看 桥接器/消费者版本兼容性指南.

npm install -g remnote-mcp-server

软件包会安装以下命令:

remnote-mcp-server --version
remnote-cli --version
remnote-mcp-stdio --version

2.安装RemNote插件

安装官方 MCP/OpenClaw自动化桥接插件 在你的 RemNote应用程序。如果从RemNote Marketplace安装,请验证插件名称和作者;名字相似 MCP Bridge 变体可能与此服务器不兼容,并导致连接循环或 1008 断开连接。配置 要连接的插件 ws://127.0.0.1:3002.

3.启动服务器

remnote-mcp-server

预期产量:

RemNote MCP Server v<version> listening { wsPort: 3002, httpPort: 3001 }

保持此终端运行。

对于在终端关闭后幸存下来并写入稳定日志文件的后台服务器:

remnote-mcp-server daemon start
remnote-mcp-server daemon status
remnote-mcp-server daemon logs
remnote-mcp-server daemon stop

守护进程状态和日志默认为 ~/.remnote-mcp-server/。在macOS上,安装登录LaunchAgent以重新启动/登录 坚持不懈:

remnote-mcp-server daemon install-launchd

在安装LaunchAgent之后, remnote-mcp-server daemon status|start|stop|restart 控制launchd服务。

4.配置您的AI客户端

文档

入门指南

用法

帮助和高级

发展

  • 开发设置 -开发者贡献指南
  • 测试策略 -三级测试模式:本地质量检查、维护 实时集成和最终用户代理验证
  • 集成测试 -用于更新和运行MCP服务器的规范共享工作流程+针对实时RemNote的CLI集成覆盖
  • 出版指南 -npm发布流程(仅限维护人员)

可用的MCP工具

工具 说明
remnote_create_note 创建带有真实别名、可选精确标签Rem ID和根文档状态的笔记、标记树或抽认卡
remnote_search 使用全文搜索、父上下文和可选标记ID/名称搜索知识库
remnote_search_by_tag 使用祖先上下文解析按精确标签Rem ID搜索
remnote_read_note 使用元数据、可选标签ID/名称以及标记或结构化内容逐个ID阅读笔记
remnote_get_media 检索一个经过验证的RemNote管理映像作为MCP本机映像内容
remnote_update_note 更新标题并添加/删除真实别名
remnote_set_document_status 预览或设置文档状态,同时保留概念/卡片状态
remnote_insert_children 在确定的位置插入子Rems
remnote_replace_children 替换直接内容子项,同时保留父元数据
remnote_update_tags 根据精确的标签Rem ID添加或删除标签
remnote_append_journal 使用可选标签Rem ID将分层内容附加到当今的日常文档中
remnote_read_table 读取高级表列、行和类型化属性元数据
remnote_get_playbook 获取推荐的MCP使用/导航手册
remnote_status 检查连接状态和统计数据

声明 outputSchema 返回MCP structuredContent 加上JSON content 文本块以实现兼容性。 看 MCP工具规范 为了 协议合同。

服务器使用 @modelcontextprotocol/sdk 支持当前MCP协议协商,包括 2025-11-25. 不要将MCP协议版本与 remnote-mcp-server 或桥接插件包版本;软件包版本使用 0.x semver和通常应该通过辅线匹配。

看 工具参考 详细用法和示例。

支持的AI客户端

  • 克劳德代码命令行界面 -基于本地终端的代理
  • 食品法典TUI/Codex.app -本地OpenAI编码代理客户端
  • 克劳德桌面/协作 -启用桌面扩展时的本地MCPB客户端,或远程连接器客户端 当本地MCPB不适用时
  • 完成 -基于任务的MCP客户端(以前称为Openwork)
  • 任何MCP客户端 支持流式HTTP传输
  • 任何本地MCP客户端 支持stdio传输 remnote-mcp-stdio
  • 任何本地命令运行器 可以打电话 remnote-cli

示例用法

创建笔记:

Create a note about "Project Ideas" with content:
- AI-powered note taking
- Personal knowledge management

搜索:

Search my RemNote for notes about "machine learning"

更新说明:

Add a tag "important" to note abc123

日记条目:

Add to my journal: "Completed the RemNote MCP integration"

看 工具参考 更多示例。

配置

环境变量

  • REMNOTE_HTTP_PORT -HTTP MCP服务器端口(默认值:3001)
  • REMNOTE_HTTP_HOST -HTTP服务器绑定地址(默认值:127.0.0.1)
  • REMNOTE_WS_PORT -WebSocket服务器端口(默认:3002)
  • REMNOTE_MEDIA_ROOTS -允许RemNote媒体根,由平台路径分隔符分隔;默认为已发现 ~/remnote/remnote-*/files 目录。等效的可重复CLI标志: --media-root.

自定义端口

remnote-mcp-server --http-port 3003 --ws-port 3004

更改端口后,更新MCP客户端配置和RemNote插件设置。

后台守护程序

remnote-mcp-server daemon start
  • 默认日志: ~/.remnote-mcp-server/remnote-mcp-server.log
  • 当守护进程PID处于活动状态时,重复启动被视为已在运行。
  • 如果配置的HTTP或WebSocket端口已被占用,则在生成第二个服务器之前启动失败。
  • 使用 remnote-mcp-server daemon stop 用于优雅关机。
  • 使用 remnote-mcp-server daemon install-launchd 在macOS上,在登录和意外情况下保持服务器运行 出口。
  • 安装launchd后,相同 daemon status/start/stop/restart 命令控制launchd服务。

看 remnote mcp服务器命令参考 对于所有选项。

故障排除

服务器无法启动:

  • 检查端口未使用: lsof -i :3001 和 lsof -i :3002
  • 验证安装: which remnote-mcp-server

插件无法连接:

  • 验证插件:websocket URL ws://127.0.0.1:3002
  • 检查服务器是否正在运行: lsof -i :3002

工具未出现:

  • 验证配置: claude mcp list
  • 完全重新启动Claude代码
  • 如果这是在升级后开始的,请验证网桥/服务器版本兼容性(0.x 次要版本可能会损坏);看 桥接器/消费者版本兼容性 指南

看 故障排除指南 详细的解决方案。

贡献与发展

开发设置:

版本兼容性提示: 当对本地或市场安装的网桥插件进行测试时,请使用与该网桥插件版本兼容的服务器签出/标记(请参阅 桥接器/消费者版本兼容性指南).

git clone https://github.com/robert7/remnote-mcp-server.git
cd remnote-mcp-server
./link-cli.sh
# Later, remove the local links for package executables:
./unlink-cli.sh

开发工作流程:

npm run dev          # Watch mode with hot reload
npm test             # Run test suite
./code-quality.sh    # Run all quality checks

看 开发设置指南 获取完整说明。

影响网桥消费者行为的拉取请求应遵循网桥仓库中的共享PR规则: 拉取请求指南特别是,对于共享功能的更改,保持网桥和服务器包行为的一致性。

有关三级测试模型和每个验证路径的链接,请参阅 测试策略.

相关项目

许可证

麻省理工学院

链接