RemNote MCP 服务器
使用说明
-
项目简介
- RemNote MCP 服务器是一套基于 Model Context Protocol 的后端服务。它通过 HTTP 提供 MCP 会话管理和 JSON-RPC 请求/响应,同时通过 WebSocket 与 RemNote 浏览器插件建立长连接桥接。服务器负责会话管理、能力声明、工具调用与资源操作等核心功能,并可与多名 AI 客户端并发工作。
-
主要功能点
- 会话管理:为多个 AI 客户端创建独立的 MCP 会话,支持初始化、请求、以及会话终止。
- 资源与工具:注册并执行 RemNote 相关工具(如创建笔记、搜索、读取、更新、日记等),通过 MCP 工具接口对外暴露。
- Prompts/模板:提供可渲染的提示模板与导航提示,帮助 LLM 客户端更高效地与知识库交互。
- 传输协议支持:HTTP(MCP 会话端点)、WebSocket(RemNote 插件桥接)以及后续流传输扩展。
- 安全与可扩展性:实现多客户端并发、会话隔离、版本兼容性检查,以及对 Bridge 版本的对比警告。
-
安装步骤
- 全局安装并运行服务端
- 安装:全局安装 remnote-mcp-server
- 启动:直接执行命令 remnote-mcp-server
- RemNote 插件端(RemNote Automation Bridge)需要在浏览器中安装并连接到 WebSocket 端点 ws://127.0.0.1:3002(默认端口,若自定义需与服务器一致)
- 配置 AI 客户端
- 客户端需要配置以连接 MCP 服务器(阅读下方“服务器配置”中的信息)。
- 常用配置与排错
- 默认情况下服务器绑定在本地回环地址,确保本地 Agent 能访问 HTTP/WS 端口。
- 如需对外暴露(云端代理或隧道),参阅文档中的远程访问指南。
- 全局安装并运行服务端
-
服务器配置(MCP 客户端需要的启动信息) 以下信息用于 MCP 客户端配置服务器的启动命令与参数,以便与 RemNote MCP 服务器建立连接。JSON 仅作描述用途,实际客户端配置需按客户端文档实现。
{ "serverName": "RemNote MCP 服务器", "command": "remnote-mcp-server", "args": [ "--http-port", "3001", "--ws-port", "3002", "--http-host", "127.0.0.1", "--log-level", "info" ] }
说明
- serverName: 服务名称,便于在多服务器环境中识别
- command: 启动 MCP 服务器的执行命令
- args: 启动参数,通常包括 HTTP/MCP 端口、WebSocket 端口、HTTP 监听地址等
- 注:上述参数应与 README/文档中的默认设置保持一致,客户端在连接时会读取服务器的端口与地址以建立通信。
-
基本使用方法
- 启动后,RemNote 插件通过 WebSocket 连接到端口 3002;AI 客户端通过 HTTP 端口 3001 与 MCP 服务器建立会话。
- 使用示例(高层次流程)
- 客户端通过 HTTP 初始化会话(initialize),服务器创建会话并返回 sessionId。
- 客户端通过会话发送 MCP 请求(如工具调用、读取笔记、搜索等),服务器将请求转发到 RemNote 插件桥接,桥接返回结果后服务器再将 JSON-RPC 格式的响应返回给客户端。
- 监控与日志:服务器提供日志输出,可按配置写入控制台、文件等;必要时可启用请求/响应日志以便审计。
- 常见排错
- 确认 RemNote 插件桥接在浏览器端已正确连接到服务器的 WebSocket。
- 确保 HTTP 与 WebSocket 端口未被防火墙或其他进程占用。
- 如遇版本不匹配,查看 Bridge 版本与服务器版本的兼容性提示。
-
备注
- 服务器实现包含完整的 MCP 核心能力:工具注册、请求分发、响应封装、会话管理与版本兼容性检查,具备可运行的服务端能力,而非仅示例或单纯客户端。