Prototype · Preview: every server in the official registry, synced every 30 minutes. Sign in with Google to write reviews.Prototype · updated every 30 min
PopNx MCPMCP servers for people who use AI · explained in plain words

Outline MCP

by ynishiversion 0.15.3i★ 0iRuns on your computerRepository ↗
Registry nameio.github.ynishi/outline-mcp

How to install

What it does

Tree-structured knowledge base as an MCP server

  • Connects Runs on your computer
  • Account or key Needs OUTLINE_MCP_DATABASE_URL
  • Category Search & AI memory

Use together with

Skills that teach the AI this kind of work; they work alongside this one

timesfm

TimesFM (Time Series Foundation Model) is a pretrained time-series foundation model developed by Google Research for time-series forecasting.

by google-research★ 35,6291 skills

Skill · How-to guide

Shadowbroker

Open-source intelligence for the global theater. Track everything from the corporate/private jets of the wealthy, and spy satellites, to seismic events in one unified interface. Hook an AI agent up to have it parse through data and find previously unseen correlations. The knowledge is available to…

by BigBodyCobain★ 11,6021 skills

Skill · How-to guide

google-maps-scraper

scrape data from Google Maps. Extracts data such as the name, address, phone number, website URL, rating, reviews number, latitude and longitude, reviews,email and more for each place

by gosom★ 8,2091 skills

Skill · How-to guide

Why it ranks here

Lists are ordered by a usage score (out of 100) built from these parts

Popularity0/80GitHub stars or weekly downloads: the larger counts 60, the smaller 20
Freshness12/12Full marks for a release or code change within 30 days
Still answering0/8The cloud endpoint answered at the last check
Usage score12/100

Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)

Install

Pick the AI app you use, then copy the settings.

Let your AI install it with one sentence

Please install Outline MCP. Follow https://mcp.popnx.com/i/ynishi-outline-mcp.md, show me the commands and wait for my OK before running them.

Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads

Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 14, 2026

First: which AI do you use?

Pick your app and the steps appear below.

Works with Claude, with some setup first

You need a Outline MCP key (create it on the maker’s site) · Install Docker on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone

Let AI install it

Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Outline MCP for Claude on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "outline": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "OUTLINE_MCP_DATABASE_URL", "ghcr.io/ynishi/outline-mcp:0.15.3" ], "env": { "OUTLINE_MCP_DATABASE_URL": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For OUTLINE_MCP_DATABASE_URL, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Outline MCP tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Docker (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    docker --version
    • A version number such as Docker version … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed

    Open the Docker download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version

    Install once; it works for everything that needs Docker

  2. Sign up and create a Outline MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    How to get a key is in the maker’s README below

  3. Open the Claude desktop app’s settings file

    SettingsDeveloperEdit Config

  4. Paste these settings and save the file

    {
      "mcpServers": {
        "outline": {
          "command": "docker",
          "args": [
            "run",
            "-i",
            "--rm",
            "-e",
            "OUTLINE_MCP_DATABASE_URL",
            "ghcr.io/ynishi/outline-mcp:0.15.3"
          ],
          "env": {
            "OUTLINE_MCP_DATABASE_URL": "your-value"
          }
        }
      }
    }

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Quit Claude and open it again

  6. Try it

    Use Outline MCP and tell me what you can do for me, then show me one thing

    ✓ If Claude says it is using Outline MCP or shows a Outline MCP tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

ChatGPT cannot connect Outline MCP yet

Outline MCP runs on your computer, but ChatGPT can only connect servers that run on the web

What you can do instead

A · Use an app that can connect Outline MCP

  • You need a Outline MCP key (create it on the maker’s site) · Install Docker on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
  • You need a Outline MCP key (create it on the maker’s site) · Install Docker on your computer first (one time)
  • You need a Outline MCP key (create it on the maker’s site) · Install Docker on your computer first (one time)
  • You need a Outline MCP key (create it on the maker’s site) · Install Docker on your computer first (one time)

B · Others in Search & AI memory that work with ChatGPT

Picked from the most used in the same category, only ones that connect by address with no key

Works with Claude Code, with some setup first

You need a Outline MCP key (create it on the maker’s site) · Install Docker on your computer first (one time)

Let AI install it

Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Outline MCP for Claude Code on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user outline --env OUTLINE_MCP_DATABASE_URL=your-value -- docker run -i --rm -e OUTLINE_MCP_DATABASE_URL ghcr.io/ynishi/outline-mcp:0.15.3 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For OUTLINE_MCP_DATABASE_URL, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Outline MCP tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Docker (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    docker --version
    • A version number such as Docker version … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed

    Open the Docker download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version

    Install once; it works for everything that needs Docker

  2. Sign up and create a Outline MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    How to get a key is in the maker’s README below

  3. Open Terminal

    Mac: press Command+Space and type Terminal · Windows: open PowerShell

  4. Paste this command and press Enter

    claude mcp add --scope user outline --env OUTLINE_MCP_DATABASE_URL=your-value -- docker run -i --rm -e OUTLINE_MCP_DATABASE_URL ghcr.io/ynishi/outline-mcp:0.15.3

    Replace “your-value” with your key before pressing Enter

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Type /mcp in Claude Code

    You should see Outline MCP listed as connected

  6. Try it

    Use Outline MCP and tell me what you can do for me, then show me one thing

    ✓ If Claude Code says it is using Outline MCP or shows a Outline MCP tool in the answer, you are connected

Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with Cursor, with some setup first

You need a Outline MCP key (create it on the maker’s site) · Install Docker on your computer first (one time)

Let AI install it

Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Outline MCP for Cursor on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "outline": { "command": "docker", "args": [ "run", "-i", "--rm", "-e", "OUTLINE_MCP_DATABASE_URL", "ghcr.io/ynishi/outline-mcp:0.15.3" ], "env": { "OUTLINE_MCP_DATABASE_URL": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For OUTLINE_MCP_DATABASE_URL, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Outline MCP tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Docker (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    docker --version
    • A version number such as Docker version … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed

    Open the Docker download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version

    Install once; it works for everything that needs Docker

  2. Sign up and create a Outline MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    How to get a key is in the maker’s README below

  3. Click this button to open Cursor

    Open in Cursor

    Cursor asks you to confirm; click Install

  4. Fill in your key

    In the Outline MCP settings, OUTLINE_MCP_DATABASE_URL is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in Cursor in Agent mode

  6. Try it

    Use Outline MCP and tell me what you can do for me, then show me one thing

    ✓ If Cursor says it is using Outline MCP or shows a Outline MCP tool in the answer, you are connected

Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Works with VS Code, with some setup first

You need a Outline MCP key (create it on the maker’s site) · Install Docker on your computer first (one time)

Let AI install it

Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.

Please install the MCP server Outline MCP for VS Code on this computer, in this order: 1) Check Docker with docker --version. If it is missing, tell me to install it from https://www.docker.com/products/docker-desktop/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "outline": { "type": "stdio", "command": "docker", "args": [ "run", "-i", "--rm", "-e", "OUTLINE_MCP_DATABASE_URL", "ghcr.io/ynishi/outline-mcp:0.15.3" ], "env": { "OUTLINE_MCP_DATABASE_URL": "your-value" } } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) For OUTLINE_MCP_DATABASE_URL, leave "your-value" in place and tell me to paste the real value myself into the file or the app’s field. Never ask me to type a key in chat. 5) Do what we agreed, then check that the Outline MCP tools really show up.

This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.

  1. Install Docker (if you don’t have it)

    Already installed? Check first · Open Terminal, type this command and press Enter

    docker --version
    • A version number such as Docker version … = installed, skip this step
    • "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
    How to open Terminal

    Mac: press ⌘ + Space, type Terminal, press Enter

    Windows: open Start, type Windows PowerShell, then Open

    Not installed: Install Docker Desktop: on Mac open Docker.dmg and drag the icon to Applications (pick Apple silicon or Intel to match your Mac) · on Windows double-click Docker Desktop Installer.exe · then open the Docker Desktop app and leave it running. No curl command needed

    Open the Docker download page ↗

    When it’s done, close Terminal, open it again and run the same command. You should see a version number: docker --version

    Install once; it works for everything that needs Docker

  2. Sign up and create a Outline MCP key

    Open the maker’s site, sign up and create an API key for the next step. Check the maker’s site for pricing and free plans.

    How to get a key is in the maker’s README below

  3. Click this button to open VS Code

    Open in VS Code

    VS Code asks you to confirm; click Install

  4. Fill in your key

    In the Outline MCP settings, OUTLINE_MCP_DATABASE_URL is empty; add your key and save

    Paste the key only into the app’s field, never into a chat or to anyone

  5. Open the AI chat in VS Code in Agent mode

  6. Try it

    Use Outline MCP and tell me what you can do for me, then show me one thing

    ✓ If VS Code says it is using Outline MCP or shows a Outline MCP tool in the answer, you are connected

Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version

Other apps that use MCP, such as Windsurf, Zed or Gemini CLI, each add servers differently. See how in the app list.

See every app that uses MCP →

JSON settings are under “For developers” below

Stuck? Ask people who use Outline MCP💬 Discussion →
For developers: Terminal commands and JSON settings

Installed on your computer

Claude Code

claude mcp add --scope user outline --env OUTLINE_MCP_DATABASE_URL=your-value -- docker run -i --rm -e OUTLINE_MCP_DATABASE_URL ghcr.io/ynishi/outline-mcp:0.15.3

Claude Desktop (claude_desktop_config.json)

{
  "mcpServers": {
    "outline": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "OUTLINE_MCP_DATABASE_URL",
        "ghcr.io/ynishi/outline-mcp:0.15.3"
      ],
      "env": {
        "OUTLINE_MCP_DATABASE_URL": "your-value"
      }
    }
  }
}

Cursor (~/.cursor/mcp.json)

{
  "mcpServers": {
    "outline": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "OUTLINE_MCP_DATABASE_URL",
        "ghcr.io/ynishi/outline-mcp:0.15.3"
      ],
      "env": {
        "OUTLINE_MCP_DATABASE_URL": "your-value"
      }
    }
  }
}

VS Code (mcp.json)

{
  "servers": {
    "outline": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "OUTLINE_MCP_DATABASE_URL",
        "ghcr.io/ynishi/outline-mcp:0.15.3"
      ],
      "env": {
        "OUTLINE_MCP_DATABASE_URL": "your-value"
      }
    }
  }
}

Values you fill in

  • OUTLINE_MCP_DATABASE_URL secret required env
    Postgres connection URL. Run `outline-mcp migrate` against it once before starting the server.

Descriptions are as written by the maker.

These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.

At a glance

Downloads per weeki
Not on npm/PyPI
Licencei
Apache-2.0
Connection
Runs on your computer
Latest versioni
0.15.3
Published to registryi
Nov 1, 2026
Code last changedi
Nov 1, 2026
Maker
ynishi
Packages
oci: ghcr.io/ynishi/outline-mcp:0.15.3
Registry status
Active

Which apps can use it

Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.

Run on your computer in

ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast

All apps, with pros and cons →

Related guides

What it can do

Runs on your computer; the tool list appears in your AI app after you install it.

Basic checksi

We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 18, 2026

  • ✓ Pass

    Maker matches the repo

    The registry name was verified with the GitHub account ynishi, which owns the repo

  • ✓ Pass

    Still maintained

    Code last changed 17 days ago

  • ✓ Pass

    Has a licence

    Uses Apache-2.0

  • – Not applicable

    Endpoint responds

    This one runs on your computer; there is no internet endpoint

  • – Not applicable

    Sign-in with OAuth

    Runs on your computer and uses local settings instead

  • … Not checked yet

    No hidden instructions in tool descriptions

    Runs on your computer; we can only read tool lists from internet endpoints

Published vulnerabilities (OSV.dev)

Not checked: only npm and PyPI packages with a version can be checked

What we check → · JSON

Makers: ask for a re-check or report wrong info
For makers: add a badge to your README

If you made this, paste this code into your README. The badge links back to this page.

[![Featured on PopNx MCP](https://mcp.popnx.com/badge/ynishi-outline-mcp.svg)](https://mcp.popnx.com/en/servers/ynishi-outline-mcp)

Discussion

Ask, share a tip or report that it does not work. Sorted by what people marked helpful.

No posts yet. Be the first to ask or share.

Posts here are written by users, not the PopNx team.

Sign in to post

User reviews

No reviews yet

Sign in to write a review

Compared with others in Search & AI memoryi

  • More stars than 0% of the other 6370 servers in this category
  • Published to the registry more recently than 69% of the other 6370 servers in this category
  • Basic checks equal to or better than 99% of the other 6370 servers in this category

Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.

Common questions

Is Outline MCP safe?

It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.

What keys or codes does it need?

You need to fill in: OUTLINE_MCP_DATABASE_URL

Does it run on my computer or in the cloud?

It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).

Is it still maintained?

The GitHub repo last changed 17 days ago, and the latest version (0.15.3) reached the registry 17 days ago.

Which apps can use it?

Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Docker on your computer.

What can I use instead?

In the same category: OpenSEO, Exa, Microsoft Learn MCP, Docs, COTAL actions (cotal.ai)

Similar alternatives

Same category, other makers, commands already checked. Official ones first, then by stars.

Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi

OpenSEO

Keyword research, site audits, rank tracking and AI visibility for your AI agent.

by every-appWidely used★ 28.2KUpdated 4 days ago

Runs in the cloud✓ everyapp.com

Exa

Connect AI agents to Exa for web search, content fetching, and multi-step research.

by exa-labsWidely used★ 5.2KUpdated 2 months ago

Runs in the cloud✓ service owner · exa.aiTried by the PopNx team

Microsoft Learn MCP

Official Microsoft Learn MCP Server – real-time, trusted docs & code samples for AI and LLMs.

by MicrosoftDocsWidely used★ 2KUpdated 12 months ago

Runs in the cloud✓ service owner · microsoft.comTried by the PopNx team

Docs

Search and read Empryo's documentation. Read-only, no auth, no local access.

by proxysoulGrowing★ 1.6KUpdated 2 months ago

Runs in the cloud✓ empryo.com
Compared with similar ones
This one
Outline MCP
OpenSEOExaMicrosoft Learn MCPDocsCOTAL actions (cotal.ai)
Runs whereInstalls on your computerRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to installRuns in the cloud, nothing to install
Needs a keyYesNoNoNoNoNo
Add with + in ClaudeNoYesYesYesNoNo
Basic checks3/35/52/44/44/44/4
LicenseApache-2.0MITMITCC-BY-4.0NOASSERTIONApache-2.0
PriceNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registryNo cost listed in the registry

README from the maker

Open the README

Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.

outline-mcp

Tree-structured knowledge base as an MCP server.

LLM sessions are ephemeral. outline-mcp gives them a persistent, editable knowledge tree — sections and content nodes that can be browsed (toc), annotated with properties, and evolved across sessions. Nodes with inject=true are automatically included in session context.

Quick Start

Books live in a Postgres database you run yourself. outline-mcp is a personal project published as-is: there is no hosted instance and no bundled database.

cargo install --path crates/outline-mcp

export OUTLINE_MCP_DATABASE_URL=postgres://user:pass@host:5432/outline outline-mcp migrate # create / update the schema; run once per upgrade outline-mcp # stdio

The server refuses to start when no database is configured, when the database cannot be reached (the message says whether the host is unreachable, the login was rejected, or the database does not exist), or when migrate has not been run against it. --database-url overrides the environment variable on every subcommand.

Claude Code (~/.claude.json)
{

"mcpServers": { "outline": { "command": "outline-mcp", "env": { "OUTLINE_MCP_DATABASE_URL": "postgres://user:pass@host:5432/outline" } } } }

Shared server (many devices)

--mcp-http serves the same tools over MCP's streamable HTTP transport. Every write is one database transaction with a per-book version check, so several server processes or devices can share one database.

outline-mcp --mcp-http                          # 127.0.0.1:8486

outline-mcp --mcp-http --bind 127.0.0.1:9000

Point clients at /mcp on that address:

{

"mcpServers": { "outline": { "type": "http", "url": "http://127.0.0.1:8486/mcp" } } }

Binding beyond loopback requires a token. Startup is refused without one, before any listener is opened:

OUTLINE_MCP_HTTP_TOKEN=<token> outline-mcp --mcp-http --bind 0.0.0.0:8486

Every request must then carry Authorization: Bearer — set it wherever your MCP client configures request headers. TLS termination is a reverse-proxy concern. Logs go to stderr in both transports; stdout stays reserved for the stdio protocol channel.

Browser view

--mcp-http also serves a read-only browser view at /ui/: the shelf, each book's table of contents (inject / status / verification / pending-revision / link markers; archived subtrees hidden unless asked), node pages (rendered body, properties, links both ways, the pending revision with its diff, history), text search (which also matches a UUID prefix of 8+ hex characters, and # such as #2-3 opens that node; the shelf's search box searches every book at once, and a node page shows its #n and 8-character id as separate click-to-select snippets) and book history. It never writes, runs no script and loads nothing from other hosts.

When OUTLINE_MCP_HTTP_TOKEN is set, the browser asks for HTTP Basic credentials: any user name, the token as the password. Without a token (loopback binds only) the view answers only requests whose Host is localhost, 127.0.0.1 or [::1]. The stdio transport has no browser view.

Service templates for running this as a daemon live in contrib/systemd/ and contrib/launchd/ (both take the database URL from their environment block). docs/runbooks/ covers hosting on Fly.io with an unmanaged Fly Postgres app (fly-io-deploy.md, config in contrib/fly/fly.toml), importing a pre-Postgres shelf (data-migration.md) and an end-to-end smoke checklist (multi-device-smoke.md).

Workflow

shelf  →  select_book  →  toc  →  node_create / node_update / node_move

node_batch_move / node_batch_update / node_query checklist / import / init / book_update / book_delete / gen_routing snapshot_create / snapshot_list / snapshot_restore / snapshot_delete node_history / dump node_locate (which book holds an id; needs no selected book) book_lint / book_stats (read-only health) node_verify (curation: verification dates) link_add / link_remove / links (curation: typed links) revision_propose / revision_show / revision_approve / revision_reject / revisions_pending (curation: review)

  1. `init` — Create a new empty book
  2. `node_create` — Add sections and content nodes (with optional properties); the result carries the new node's UUID, ready for the batch tools
  3. `toc` — View the table of contents with numbered IDs (e.g. 1, 2-3). Supports filter by properties, max_depth (depth from the book root; 1 = root level only) and limit; a last line counts the nodes left out. Archived nodes and their subtrees are hidden (counted on a last line) unless include_archived: true, which shows them marked [archived]
  4. `select_book` — Select a book. Nodes with inject=true property have their body auto-appended (draft and archived nodes, and everything under an archived section, excluded; the TOC it prints hides archived subtrees like toc)
  5. `checklist` — Export a section (or the whole book) as a Markdown checklist with checkboxes. Archived subtrees are left out unless include_archived: true (or subtree_root is itself archived)
  6. `node_update` — Edit title, body, type, placeholder, properties, or status of a node. Status is active, draft (not written yet) or archived (retired: kept readable, but not injected and hidden from toc / node_query unless asked for)
  7. `node_move` — Relocate or delete nodes; descendants go along and are listed in the result. dry_run: true shows every node that would move or be removed (old → new positions) without changing anything. A remove records a delete in history for the node and each descendant
  8. `node_batch_move` — Move multiple nodes in a single atomic call (requires UUID or UUID-prefix IDs; to delete a node, use node_move with action: "remove"); also takes dry_run
  9. `node_batch_update` — Update title/body/type/properties/status on multiple nodes atomically
  10. `node_query` — Search nodes by property values, status (active/draft/archived), type (section/content), text (case-insensitive substring of title or body, CJK included, with a snippet of the first body match), or verified_before (nodes never verified or last verified before a date / datetime / millis); optionally include body in results. Archived nodes come back only with status: "archived" or include_archived: true
  11. `import` — Import a book from a previously exported JSON file, restoring status, verification, links and pending revisions. Node ids in the file are kept, so re-importing a book's own export changes only what differs; new_ids: true imports a copy with fresh ids (links between imported nodes are remapped). Links to nodes not in the file, and pending revisions that break the revision rules, are dropped and reported. The result counts nodes created, updated and deleted (nodes of the book that are not in the file are deleted). A file exported from one section (marked in the file, or recognized from its node ids for exports older than the marker) is refused unless force: true, since it would replace the whole book
  12. `gen_routing` — Generate a Markdown routing table from nodes with routing property across all books
  13. `snapshot_create` / `snapshot_list` / `snapshot_restore` / `snapshot_delete` — Full book versioning (create, list, restore, delete one snapshot; a labeled snapshot needs force: true to delete)
  14. `node_history` — View per-node change log with before/after diffs
  15. `dump` — Export full book as JSON file

15a. `node_locate` — Find which book holds a node, by UUID or a prefix of at least 8 hex digits (the short id); searches every book and needs no selected book. Archived books are skipped unless include_archived: true; archived nodes of a searched book are listed with their status

  1. `book_delete` — Delete a book with its nodes, history and snapshots (cannot be undone). The slug is required; a book with any nodes, history or snapshots needs force: true, and dry_run: true only reports what would be removed. A write to the book between the check and the delete makes the delete fail without removing anything
  2. `book_update` — Change a book's title and / or max_depth (slug required). Lowering max_depth below an existing node's depth is refused and names that node; the change appears in book_history as a book_update entry
  3. `book_lint` — Read-only structural checks on a book (slug defaults to the selected book): content nodes at the root, similar titles (Jaccard over title words; character pairs for CJK; threshold default 0.6; pairs where both titles are a single token are skipped unless the titles are identical), property keys differing only by case / _ / - / spaces, sections without children, drafts not updated for stale_days (default 90), and links whose target is not in the book (dangling_links). Archived nodes and everything under an archived section are ignored by every check. checks runs a subset; limit (default 50) caps findings per check and counts the rest; format: "json" for programs
  4. `book_stats` — Read-only numbers for a book: node counts, max / mean depth, children per section (max, mean, histogram), counts by status, injected nodes, update recency, distinct property keys, links; format: "json" for programs
  5. `node_verify` — Record that nodes were confirmed to still match reality (node_ids, optional by): sets their verification time to now without touching content or last-edited time; one history entry per node, one commit. Pair with node_query verified_before to list what nobody has confirmed lately
  6. `link_add` / `link_remove` / `links` — Typed links between nodes of a book (rel such as supersedes, superseded_by, see_also, merged_from; any 1–40 of a-z 0-9 _ -). Links follow the target's id, so moving it keeps them; removing a node drops the links pointing at it (each holder gets an update in history, in the same commit, and the result says how many were dropped). links lists outgoing links and backlinks; node_query takes linked_to (+ link_rel) and its JSON carries links / backlinks (with each endpoint's status, archived included). A link change is recorded in history but, like node_verify, leaves the node's updated_at alone
  7. `revision_propose` / `revision_show` / `revision_approve` / `revision_reject` / `revisions_pending` — Changes under review. revision_propose attaches a proposed title / body / properties change (by, note optional) to a node without changing it: injection, toc, dump and every read keep the current content until approval. One pending revision per node (replace: true swaps it); archived nodes take none. revision_show gives a diff against the current content (title, unified body diff, properties added / changed / removed) and warns when the node changed since; revision_approve applies it (validated like node_update) as one history entry, refusing a stale one unless force: true; revision_reject drops it; revisions_pending lists them. Proposing and rejecting are recorded in history without touching updated_at. node_query shows a pending revision's summary, book_lint reports stale_proposals (older than stale_days, outdated, or left on a node archived since — those can only be rejected), book_stats counts them
Node IDs

toc assigns hu

Only the beginning is shown; read the rest in the repo