Roam Research MCP Server

MCP server and CLI for Roam Research

Local serverstdioTypeScript

What is the Roam Research MCP Server?

Roam Research MCP connects Roam Research MCP to AI assistants that speak the Model Context Protocol. MCP server and CLI for Roam Research.

What Roam Research MCP does

I created this project to solve a personal problem: I wanted to manage my Roam Research graph directly from Claude Code (and other LLMs). As I built the Model Context Protocol (MCP) server to give AI agents access to my notes, I realized the underlying tools were powerful enough to stand on their own.

Practical notes

  • Maintained by 2b3pro, written in TypeScript.

More MCP options

Compare MCP servers by category, or browse hosted MCP servers if you prefer an endpoint over a local process.

Maintainer setup documentation.

Recorded tools

Check the linked publisher documentation and your connected client's tool list. Names and availability can vary with the server version and account permissions.

ToolWhat it does
roam_fetch_page_by_titleFetch page content by title.
roam_fetch_page_full_viewFetch a page's content plus all linked references with breadcrumb context and children.
roam_fetch_blockFetch a block by UID with optional children (depth) and/or ancestors (up to page root).
roam_create_pageCreate new pages, optionally with mixed text and table content.
roam_update_page_markdownUpdate a page using smart diff (preserves block UIDs).
roam_get_subpagesList sub-pages under a namespace prefix (e.g. "Project/") with optional tag filter.
roam_search_by_textFull-text search across the graph or within specific pages. Supports namespace prefix search for page titles.
roam_search_block_refsFind blocks that reference a page, tag, or block UID.
roam_search_by_statusFind TODO or DONE items.
roam_search_for_tagFind blocks containing specific tags (supports exclusion).
roam_search_by_dateFind blocks/pages by creation or modification date.
roam_find_pages_modified_todayList pages modified since midnight.
roam_add_todoAdd TODO items to today's daily page.
roam_create_tableCreate properly formatted Roam tables.

How to install the Roam Research MCP Server

{
  "mcpServers": {
    "roam-research": {
      "command": "npx",
      "args": ["-y", "roam-research-mcp"],
      "env": {
        "ROAM_API_TOKEN": "your-token",
        "ROAM_GRAPH_NAME": "your-graph"
      }
    }
  }
}

Configuration as documented by the project. Restart the client after saving.

Configuration

VariableDescriptionRequired
ROAM_API_TOKENCredential the server authenticates with.Yes
ROAM_GRAPH_NAMEConfiguration value read at startup.Optional
ROAM_GRAPHSConfiguration value read at startup.Optional
ROAM_DEFAULT_GRAPHConfiguration value read at startup.Optional
ROAM_SYSTEM_WRITE_KEYCredential the server authenticates with.Yes
HTTP_STREAM_HOSTEndpoint or connection string the server talks to.Optional
HTTP_AUTH_TOKENCredential the server authenticates with.Yes

Example prompts to try

  • “Use Roam Research MCP to roam fetch page by title.”
  • “Use Roam Research MCP to roam fetch page full view.”
  • “Use Roam Research MCP to roam fetch block.”

Frequently asked questions

MCP server and CLI for Roam Research Confirm the tools offered by your installed version in the connected client. Tool availability and permissions depend on the server and account configuration.