Introduction

A Rust SDK, terminal UI, and MCP server for Roam Research.

The roam-sdk crate provides three things in one package:

• SDK — a Rust client for the Roam Research API. Use it to build your own tools, scripts, or integrations.

• TUI — a terminal-based interface for navigating and editing your Roam graph.

• MCP Server — expose your Roam graph to AI assistants via the Model Context Protocol.

Quick links

I want to...	Go to
Use the terminal app	TUI Installation
Configure the app	Configuration
Learn keybindings	Keybindings
Export notes	Export
Select multiple blocks	Multi-Block Selection
Set up MCP for AI assistants	MCP Setup
See MCP tools	Tools Reference
Use the Rust SDK	SDK Getting Started
See API reference	Client, Types, Queries

Architecture

roam-sdk (crate)
├── lib.rs          → SDK: RoamClient, types, queries, errors
├── main.rs         → TUI: terminal interface using the SDK
├── mcp.rs          → MCP: stdio server with 18 tools
└── export.rs       → Export: markdown and JSON formatters

The TUI is built on Ratatui + Tokio and uses the SDK internally. The MCP server uses rmcp for the Model Context Protocol implementation. Both ship from the same crate — install the binary with cargo install roam-sdk, or add the library with cargo add roam-sdk.