BN

bnomei/nereid

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

68 stars 3 forks 质量 64 趋势 18NOASSERTION

与AI代理协作创建和探索美人鱼图(TUI + MCP服务器)

概览

Nereid 是一个面向终端优先、用于美人鱼支持图的工作区。它结合了 ratatui TUI、模型上下文协议(MCP)服务器、基于文件夹的会话持久化和确定性文本渲染,使人类和 AI 代理能够检查并更新同一图解会话。 - 从终端浏览和编辑序列图、流程图、类图、实体-关系(ER)和甘特图,- 将图表、攻略、交叉引用、选择和活动状态保存在本地会话文件夹中,- 提供用于图表导航、结构化变异(包括序列块)、xref、攻略和图查询的类型MCP工具,- 当指纹仍匹配时,用保持身份的调和替换Mermaid源,- 导出Mermaid源及文本预览,支持可审阅的文件式工作流程。 Nereid 仅供非商业用途使用。

概述(AI 翻译)

Nereid 是一个面向终端的、用于美人鱼支持的图表工作区。它结合了 ratatui TUI、模型上下文协议(MCP)服务器、基于文件夹的会话持久化以及确定性文本渲染,使人类和人工智能代理能够检查并更新同一图表会话。

想用奈瑞德时:

  • 从终端浏览和编辑序列、流程图、类、实体关系(ER)和甘特图,
  • 将图表、攻略、交叉引用、选择和活动状态保存在本地会话文件夹中,
  • 提供用于图表导航、结构化变异(包括序列块)、xref、通关和图查询的类型化MCP工具,
  • 当指纹仍匹配时,用保持身份的调和替代美人鱼来源,
  • 导出美人鱼源码及文本预览,支持可审阅的文件工作流程。

Nereid 仅供非商业用途使用。商业使用、产品使用、付费服务使用、内部业务使用、再分发、再许可或修改发行需要单独书面许可。参见许可条款。

近期发行

  • **0.

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

nereid

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:

  • browse and edit sequence, flowchart, class, entity-relationship (ER), and Gantt diagrams from a terminal,
  • keep diagrams, walkthroughs, cross-references, selections, and active state in a local session folder,
  • expose typed MCP tools for diagram navigation, structured mutation (including sequence blocks), xrefs, walkthroughs, and graph queries,
  • replace Mermaid sources with identity-preserving reconcile when fingerprints still match,
  • export Mermaid sources plus text previews for reviewable, file-based workflows.

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.

Recent releases

  • 0.9: Added class, entity-relationship, and Gantt diagrams across parsing, text rendering, the TUI, persisted sessions, and typed MCP reads. The built-in demo now covers all five diagram families.
  • 0.8: Added structured sequence block and section ops plus diagram_replace_from_mermaid, which reconciles stable identities during bulk Mermaid rewrites and reports dangling xrefs.
  • 0.7: Added the fuzzy : diagram switcher and persisted Frigg symbol anchors for sequence participants and flowchart nodes.

See CHANGELOG.md for the complete release history.

Installation

Prerequisites

  • Rust 1.85 or newer when installing with Cargo or building from source.
在 GitHub 查看完整 README

安装

npx @bnomei/nereid --version
新手?先看 mcpskill.org 教程 →

配置

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