How do I install the nereid mcp server?

Use a recorded configuration for your client, replace example credential values and paths, and verify the documented runtime. Restart or reconnect the client, then inspect the available tools.

SSyncDev

Start a project

Nereid MCP Server

Nereid is a terminal-first workspace for Mermaid-backed diagrams. It combines a `ratatui` TUI, a Model Context Protocol (MCP) server, folder-based

Local serverstdio

What is the Nereid MCP Server?

Nereid is a terminal-first workspace for Mermaid-backed diagrams. It combines a ratatui TUI, a Model Context Protocol (MCP) server, folder-based session

Configuration and credentials

Rust 1.85 or newer when installing with Cargo or building from source. - A terminal that supports alternate-screen TUI applications. - Optional: VISUAL or EDITOR for the in-app Mermaid editor. Nereid falls back to vi. Installing Nereid does not grant unrestricted rights. The same source-available noncommercial license applies to crates.io, Homebrew, GitHub Releases, npm, Docker, and

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.

Tool	What it does
nereid-session.meta.json	Session id, active diagram and walkthrough ids, diagram index, xrefs, and selection state.

How to install the Nereid MCP Server

{
  "mcpServers": {
    "nereid": {
      "command": "nereid",
      "args": [
        "--mcp",
        "--session",
        "/absolute/path/to/session"
      ]
    }
  }
}

From the project documentation. Replace placeholders and example paths before connecting.

Configuration

Rust 1.85 or newer when installing with Cargo or building from source. - A terminal that supports alternate-screen TUI applications. - Optional: VISUAL or EDITOR for the in-app Mermaid editor. Nereid falls back to vi. Installing Nereid does not grant unrestricted rights. The same source-available noncommercial license applies to crates.io, Homebrew, GitHub Releases, npm, Docker, and

Example prompts to try

“Use Nereid to Optional.”
“Use Nereid to Walkthroughs.”
“Use Nereid to Cross.”

Frequently asked questions

Nereid is a terminal-first workspace for Mermaid-backed diagrams. It combines a `ratatui` TUI, a Model Context Protocol (MCP) server, folder-based session Confirm the tools offered by your installed version in the connected client. Tool availability and permissions depend on the server and account configuration.