Power your agent
पब्लिशर का इंस्टॉल। PlugMCP एंडपॉइंट नहीं।
Host a copy with our keys and logs.
रजिस्ट्री में अभी कोई पैकेज्ड रिलीज़ नहीं है। रिपॉज़िटरी का README देखें.
रिमोट URL या आपकी मशीन पर कमांड? दोनों इंस्टॉल में क्या अंतर है
PlugMCP पर चलाएँ
A new server you create. It is not this listing's official endpoint. Use the publisher install when you want their URL and their credentials.
लॉन्चNereid is a terminal-first workspace for Mermaid-backed diagrams. It combines a ratatui TUI, a Model Context Protocol (MCP) server, folder-based session persistence, and deterministic text renders so humans and AI agents can inspect and update the same diagram session.
Use Nereid when you want to:
Nereid is source-available for noncommercial use only. Commercial use, product use, paid service use, internal business use, redistribution, sublicensing, or modified distribution requires separate written permission. See License.
diagram_replace_from_mermaid, which reconciles stable identities during bulk Mermaid rewrites and reports dangling xrefs.: diagram switcher and persisted Frigg symbol anchors for sequence participants and flowchart nodes.See CHANGELOG.md for the complete release history.
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 source builds.
cargo install nereid
nereid --version
brew install bnomei/nereid/nereid
nereid --version
Requires Node.js 18 or newer. The wrapper supports Linux and macOS on x64 or arm64, plus Windows on x64. Linux and macOS also need tar to extract the downloaded release archive.
npx @bnomei/nereid --version
The npm package is a thin wrapper. On first run it downloads the matching GitHub Release binary, verifies the published .sha256, caches it locally, and forwards argv to the binary.
docker run --rm ghcr.io/bnomei/nereid:0.9.0 --version
The image is built from published musl Linux release assets. Prefer binding a session directory for MCP or file-backed work:
docker run --rm -i -v "$PWD/my-session:/workspace/my-session" ghcr.io/bnomei/nereid:0.9.0 --mcp --session /workspace/my-session
The -i flag keeps stdin open for the stdio MCP transport. Add -t as well when you run the interactive TUI in Docker.
Download a release archive from GitHub Releases, review the included license notice, extract the archive, and put the nereid binary on your PATH.
git clone https://github.com/bnomei/nereid.git
cd nereid
cargo build --release
./target/release/nereid --version
Run the built-in demo session:
nereid --demo
From a source checkout, use Cargo:
cargo run -- --demo
Expected result:
? to open the in-app help.q to quit.http://127.0.0.1:27435/mcp.Create or open a persistent session folder:
mkdir my-session
nereid my-session
If the folder has no session metadata, no existing diagrams/*.mmd files, and no existing walkthroughs/*.wt.json files, Nereid initializes a seed flow diagram. If durable diagram or walkthrough files exist without nereid-session.meta.json, Nereid refuses to seed a new session so those files cannot be orphaned; restore the metadata index to repair the session. For an existing session, Nereid loads the metadata index and its referenced diagram and walkthrough files.
CLI synopsis:
nereid [<session-dir>] [--durable-writes] [--mcp-http-port <port>]
nereid [--session <dir>] [--durable-writes] [--mcp-http-port <port>]
nereid --demo [--mcp-http-port <port>]
nereid [<session-dir>] [--durable-writes] --mcp
nereid [--session <dir>] [--durable-writes] --mcp
nereid --demo --mcp
nereid --dump-mcp-tool-schema
Rules:
session-dir and --session are omitted, Nereid uses the current working directory.--demo cannot be combined with a session directory.--mcp-http-port is only valid in TUI mode.--durable-writes opts into slower best-effort durable persistence with fsync or sync where supported.Source: src/main.rs.
A session folder is the source of truth for durable Nereid state. The TUI and persistent MCP server both read and write this folder.
Nereid may rewrite managed files while it runs. Use the TUI e key to edit the active diagram in $VISUAL or $EDITOR, or stop Nereid before making manual changes. Text render exports are generated asynchronously and can briefly lag behind .mmd or .wt.json updates during rapid edits.
Source: src/store/session_folder.rs.
Nereid parses a deliberate Mermaid subset and reports unsupported syntax as an actionable error.
Sequence diagrams support:
sequenceDiagram as the first non-empty line,%%,participant <name> and <role> <name> declarations,alice->>bob: Hello,alt, opt, loop, and par blocks,else inside alt, and inside par, and end block closures.Flowcharts support:
flowchart or graph as the first non-empty line, with optional TD, TB, LR, RL, or BT direction,%%,<id>, <id>[<label>], <id>(<label>), and <id>{<label>},A -->|label| B and A -- label --> B forms,A --> B --> C,linkStyle statements, which are preserved on export. Per-edge styles containing the literal word dashed produce dashed text-render strokes; other CSS properties and linkStyle default do not affect text rendering.Class diagrams support:
classDiagram as the first non-empty line,%%,ClassName : member form; members containing ( are methods and the rest are attributes,:,Entity-relationship diagrams support:
erDiagram as the first non-empty line,%%,--) and non-identifying (..) relationships,||, |o, o|, |{, }|, }o, and o{,:,Gantt diagrams support:
gantt as the first non-empty line,%%,title and dateFormat lines,section groups,YYYY-MM-DD start or after <tag> dependency, and a day duration such as 14d,Parsed sequence participant and flowchart node names must be non-empty ASCII alphanumeric strings or underscores. They cannot contain whitespace or /. Class and ER names additionally allow hyphens. Gantt task labels are free-form text before the task metadata colon.
Sources: src/format/mermaid/sequence.rs, src/format/mermaid/flowchart.rs, src/format/mermaid/class.rs, src/format/mermaid/er.rs, src/format/mermaid/gantt.rs, src/format/mermaid/ident.rs.
Press ? in Nereid for the full scrollable help panel.
Common keys:
By default, Nereid uses the terminal ANSI palette. Set NEREID_TUI_PALETTE to override foreground, background, and the 16 ANSI colors.
Value shape:
<fg>,<bg>,<black>,<red>,<green>,<yellow>,<blue>,<magenta>,<cyan>,<white>,<bright_black>,<bright_red>,<bright_green>,<bright_yellow>,<bright_blue>,<bright_magenta>,<bright_cyan>,<bright_white>
Each color must be #RRGGBB, 0xRRGGBB, or rgb:rr/gg/bb. NEREID_PALETTE is accepted as an alias.
Sources: src/tui/chrome.rs, src/tui/theme.rs.
Nereid exposes MCP tools for live diagram collaboration.
The server advertises tools only; it does not expose MCP resources or prompts. The repository playbooks described below are examples for MCP clients, not registered prompt capabilities.
Transports:
http://127.0.0.1:<port>/mcp, default port 27435.nereid --mcp --session path/to/session.For clients that launch stdio servers, add a server entry like this and replace the session path with an absolute path:
{
"mcpServers": {
"nereid": {
"command": "nereid",
"args": ["--mcp", "--session", "/absolute/path/to/session"]
}
}
}
If Nereid is already running in TUI mode, connect a Streamable HTTP client to http://127.0.0.1:27435/mcp, or to the port selected with --mcp-http-port.
Tool groups:
diagram_list, diagram_current, diagram_open, diagram_delete, diagram_read, diagram_stat, diagram_get_ast, diagram_get_slice, diagram_render_text, diagram_diff.diagram_create_from_mermaid, diagram_replace_from_mermaid, diagram_propose_ops, diagram_apply_ops (sequence structure ops for blocks/sections/membership).walkthrough_list, walkthrough_current, walkthrough_open, walkthrough_read, walkthrough_stat, walkthrough_get_node, walkthrough_render_text, walkthrough_diff, walkthrough_apply_ops.attention_human_read, attention_agent_read, attention_agent_set, attention_agent_clear, follow_ai_read, follow_ai_set, selection_read, selection_update, view_read_state.xref_list, xref_neighbors, xref_add, xref_remove, object_read.route_find, seq_messages, seq_search, seq_trace, flow_reachable, flow_paths, flow_cycles, flow_unreachable, flow_dead_ends, flow_degrees.Object refs use this canonical shape:
d:<diagram_id>/<category...>/<object_id>
Examples:
d:demo-flow/flow/node/n:a
d:demo-seq/seq/message/m:0001
d:demo-seq/seq/block/b:0000
d:demo-seq/seq/section/sec:0000:00
d:demo-class/class/class/c:Class01
d:demo-class/class/relation/r:0001
d:demo-er/er/entity/e:CUSTOMER
d:demo-er/er/relationship/r:0001
d:demo-gantt/gantt/section/sec:0001
d:demo-gantt/gantt/task/t:0001
d:demo-gantt/gantt/lane/lane:2014-01-01
Canonical category pairs are seq/participant, seq/message, seq/block, seq/section, flow/node, flow/edge, class/class, class/relation, er/entity, er/relationship, gantt/section, gantt/task, and gantt/lane.
Gantt lanes with valid YYYY-MM-DD task starts use calendar-stable ids such as
lane:2026-01-08; charts without parseable absolute dates use relative ids such as lane:0007.
Sequence participants and flowchart nodes can carry an optional Frigg code-symbol anchor with a lowercase hexadecimal stable_symbol_id such as sym-16c57df0026ced40 and an optional repository_id. Set or clear anchors with the seq_set_participant_symbol and flow_set_node_symbol ops passed to diagram_apply_ops or diagram_propose_ops.
Anchors appear in diagram_get_ast and object_read responses. Nereid persists them in diagrams/*.meta.json, separate from Mermaid source, so adding an anchor does not rewrite the corresponding .mmd file.
Sequence and flowchart diagrams support structured MCP mutation ops. Edit class, ER, and Gantt diagrams with diagram_replace_from_mermaid or the TUI editor; their kind-specific AST and object reads remain available for inspection and verification.
Prefer structure ops for local alt/opt/loop/par edits. Use diagram_replace_from_mermaid for bulk Mermaid rewrites; matching fingerprints keep stable ids, and the response reports preserved/dropped/new ids plus dangling xrefs on the target diagram.
The reviewable schema snapshot lives at src/mcp/server/tool_schema.snapshot.json. Regenerate it after changing tool names, descriptions, input schemas, or output schemas:
cargo run -- --dump-mcp-tool-schema > src/mcp/server/tool_schema.snapshot.json
cargo test mcp_tool_schema_snapshot_is_current
The repository includes a persisted demo session in data/demo-session. It contains sequence, flowchart, class, ER, and Gantt diagrams, plus xrefs and a walkthrough that exercise the TUI and MCP tools. The demo index links to every diagram family.
Playbook prompts for MCP clients live in tests/playbooks. Example tasks include:
diagram_list."places relationship in the ER demo and return its canonical relationship ref."after dependency from Another task back to A task."Run the standard checks before review:
cargo fmt
cargo clippy --all-targets --all-features
cargo test
Run Criterion benchmark baselines:
./scripts/bench-criterion save
./scripts/bench-criterion compare
Run local pre-commit hooks:
prek validate-config prek.toml
prek run --all-files
prek install
Release helpers live in scripts, and GitHub Actions workflows live in .github/workflows.
Nereid Source-Available Noncommercial License v1.0. Noncommercial use is allowed only under the terms in LICENSE. Commercial use, product use, paid service use, internal business use, redistribution, sublicensing, modified distribution, or incorporation into another project requires separate prior written permission from the copyright holder.
Create and explore Mermaid diagrams in collaboration with AI agents (TUI + MCP Server)
टूल
अभी टूल सूची नहीं है। रिमोट सर्वर को पहले हेल्थ चेक के बाद सूची मिलती है।
FAQ
इस पेज पर Cursor, Claude Desktop, Claude Code या VS Code के लिए stdio कॉन्फ़िग कॉपी करें। यह पब्लिशर का इंस्टॉल इस्तेमाल करता है, PlugMCP प्रॉक्सी नहीं।
इस रिकॉर्ड में कोई ज़रूरी एनवायरनमेंट वेरिएबल दर्ज नहीं है।
Nereid stdio पर लोकल चलता है।
पिछली जाँच 2026-11-05 को हुई। Create and explore Mermaid diagrams in collaboration with AI agents (TUI + MCP Server)