Roam Research MCP Server

Roam Research MCP Server

site icon
2025.03.22 34
TypeScript知识管理AI集成自动化工具开发效率内容生成
Roam Research MCP Server 是一个模型上下文协议(MCP)服务器,提供对 Roam Research API 功能的全面访问。该服务器使 AI 助手(如 Claude)能够通过标准化接口与用户的 Roam Research 知识图谱进行交互。
View on GitHub

Overview

基本能力

产品定位

Roam Research MCP Server 是一个中间件服务,旨在为 AI 助手提供与 Roam Research 知识图谱交互的标准化接口。

核心功能

  • 环境变量处理与 .env 支持
  • 全面的输入验证
  • 不区分大小写的页面标题匹配
  • 递归块引用解析(最多4层)
  • Markdown 解析与转换
  • 每日页面集成
  • 详细的调试日志
  • 高效的批量操作
  • 层次化大纲创建

工具列表

  1. roam_fetch_page_by_title: 通过标题获取页面内容
  2. roam_create_page: 创建新页面
  3. roam_create_block: 在页面中创建新块
  4. roam_import_markdown: 导入嵌套的 Markdown 内容
  5. roam_add_todo: 在今日页面添加待办事项
  6. roam_create_outline: 创建层次化大纲
  7. roam_search_block_refs: 搜索块引用
  8. roam_search_hierarchy: 搜索块层级关系
  9. roam_find_pages_modified_today: 查找今日修改的页面
  10. roam_search_by_text: 按文本搜索块
  11. roam_update_block: 更新块内容
  12. roam_search_by_date: 按日期搜索
  13. roam_search_for_tag: 按标签搜索
  14. roam_remember: 存储记忆信息
  15. roam_recall: 回忆记忆信息
  16. roam_datomic_query: 执行高级数据查询

适用场景

  • AI 助手与知识图谱交互
  • 自动化知识管理
  • 批量内容导入/导出
  • 高级数据查询与分析
  • 日常任务管理

常见问题解答

  • 需要配置 Roam Research API token
  • 支持通过 .env 文件或 MCP 设置配置环境变量
  • 提供详细的错误处理机制

使用教程

使用依赖

  • Node.js 环境
  • npm 包管理器

安装教程

全局安装:

npm install -g roam-research-mcp

或从源码构建:

git clone https://github.com/2b3pro/roam-research-mcp.git
cd roam-research-mcp
npm install
npm run build

调试方式

使用 MCP Inspector 测试:

npx @modelcontextprotocol/inspector node build/index.js

开发模式下自动重新编译:

npm run watch

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。