Roam Research MCP Server

Roam Research MCP Server

用于Roam Research图集成的MCP Server。

GitHub
Created By2b3pro2b3pro

npm 版本 项目状态: WIP 许可证: MIT

概述

Roam Research MCP 服务器为AI助手提供了与Roam Research图谱交互的标准化接口。

安装

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

设置

  1. 获取API令牌：

    • 在Roam图谱设置中，导航至 "Graph" > "API Tokens" > "+ New API Token"
    • 复制生成的令牌

  2. 配置环境变量（两种方式）：

    方式1: 创建.env文件

    ROAM_API_TOKEN=your-api-token
ROAM_GRAPH_NAME=your-graph-name
MEMORIES_TAG='#[[LLM/Memories]]'

    方式2: 在MCP设置文件中配置

    {
  "mcpServers": {
    "roam-research": {
      "command": "node",
      "args": ["/path/to/roam-research-mcp/build/index.js"],
      "env": {
        "ROAM_API_TOKEN": "your-api-token",
        "ROAM_GRAPH_NAME": "your-graph-name",
        "MEMORIES_TAG": "#[[LLM/Memories]]"
      }
    }
  }
}

核心功能示例

获取页面内容

use_mcp_tool roam-research roam_fetch_page_by_title {
  "title": "示例页面"
}

创建页面

use_mcp_tool roam-research roam_create_page {
  "title": "新页面",
  "content": "页面的初始内容"
}

添加块

use_mcp_tool roam-research roam_create_block {
  "content": "块内容",
  "title": "目标页面标题"  // 可选，默认为今天的日记页
}

创建大纲

use_mcp_tool roam-research roam_create_outline {
  "outline": [
    { "text": "I. 顶级项目", "level": 1 },
    { "text": "A. 第二级", "level": 2 },
    { "text": "1. 第三级", "level": 3 }
  ],
  "page_title_uid": "目标页面"  // 可选，默认为今天的日记页
}

添加待办事项

use_mcp_tool roam-research roam_add_todo {
  "todos": [
    "第一个待办事项",
    "第二个待办事项"
  ]
}

其他可用功能

  • roam_import_markdown: 导入嵌套的Markdown内容
  • roam_search_block_refs: 搜索块引用
  • roam_search_hierarchy: 导航块层次结构
  • roam_search_by_text: 搜索包含特定文本的块
  • roam_update_block: 更新块内容
  • roam_remember: 存储记忆或信息
  • roam_recall: 检索记忆
  • roam_datomic_query: 执行自定义Datalog查询

完整文档请参考GitHub仓库。