关键词

Roam Research知识库AI 助手内容管理数据访问

使用说明

项目简介

Roam Research MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 AI 助手提供与 Roam Research 知识库交互的标准接口。通过该服务器，AI 助手可以安全、可扩展地访问和操作 Roam Research 中的页面、块等资源，并执行预定义的功能，如内容检索、创建页面、更新块等。

主要功能点

  • 提供多种工具，如 'roam_fetch_page_by_title' (获取页面内容)、'roam_create_page' (创建页面)、'roam_create_block' (创建块)、'roam_search_by_text' (文本搜索) 等，方便 AI 助手操作 Roam Research。
  • 支持通过环境变量或 MCP 设置进行配置，灵活适应不同的使用场景。
  • 提供了详细的错误处理和日志记录，方便开发者调试和维护。

安装步骤

  1. 确保已安装 Node.js 和 npm。
  2. 克隆 GitHub 仓库: 
    git clone https://github.com/2b3pro/roam-research-mcp.git
  3. 进入项目目录: 
    cd roam-research-mcp
  4. 安装依赖: 
    npm install
  5. 构建项目: 
    npm run build

服务器配置

MCP 服务器需要配置 Roam Research API 令牌 (ROAM_API_TOKEN) 和 Graph 名称 (ROAM_GRAPH_NAME) 才能连接到您的 Roam Research 知识库。您可以选择以下两种方式配置：

  • 方式一：使用 .env 文件 (推荐开发环境) 在项目根目录下创建 '.env' 文件，并添加以下内容，替换为您自己的 API 令牌和 Graph 名称：

    ROAM_API_TOKEN=your-api-token
ROAM_GRAPH_NAME=your-graph-name

  • 方式二：使用 MCP 客户端设置 在 MCP 客户端（例如 Claude）的设置中，配置 MCP 服务器连接信息。以 JSON 格式配置服务器启动命令 (command) 及其参数 (args)。以下是配置示例，请根据实际的项目路径进行调整：

    {
  "serverName": "roam-research",  // 服务器名称，自定义
  "command": "node",             // 启动命令
  "args": ["/path/to/roam-research-mcp/build/index.js"] // 启动参数，指向构建后的 index.js 文件路径
}

    请注意： 上述 JSON 配置仅包含 'command' 和 'args'，MCP 客户端通常允许在图形界面中直接配置 服务器名称 (serverName)。环境变量 (env) 通常在高级配置或特定客户端设置中进行配置，对于 Claude 客户端，环境变量可以在 'cline_mcp_settings.json' 或 'claude_desktop_config.json' 中配置，但更推荐使用 '.env' 文件进行配置。

基本使用方法

  1. 启动服务器：在项目根目录下运行 'npm start' 命令 (package.json 中 scripts 定义了 start 命令为 'node build/index.js')。
  2. 在 MCP 客户端（如 Claude）中配置并连接到 Roam Research MCP 服务器。
  3. 使用 MCP 客户端提供的 'use_mcp_tool' 或类似指令，调用服务器提供的工具，例如： 
    use_mcp_tool roam-research roam_fetch_page_by_title { "title": "Example Page" }
    具体工具的使用方法和参数请参考仓库 README.md 文件中的 "Usage" 部分。

信息

分类

生产力应用

访问项目