# mermind-mcp

**Repository Path**: nur/mermind-mcp

## Basic Information

- **Project Name**: mermind-mcp
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-24
- **Last Updated**: 2026-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mermaid MCP Server

MCP 服务器，用于自动启动 Mermaid Live Editor 并在浏览器中打开 Mermaid 图表。

## 功能

- 自动启动/停止 Mermaid Live Editor
- 在浏览器中打开 Mermaid 图表
- 支持从文件或直接内容加载图表
- 检查编辑器运行状态

## 安装

```bash
cd /Users/px/Documents/freelancer/jin/mcp-mermaid-server
npm install
```

## 配置

在 Claude Code 的配置文件中添加此 MCP 服务器：

**macOS/Linux**: `~/.claude/settings.json`

```json
{
  "mcpServers": {
    "mermaid": {
      "command": "node",
      "args": ["/Users/px/Documents/freelancer/jin/mcp-mermaid-server/index.js"]
    }
  }
}
```

## 可用工具

### 1. `start_mermaid_editor`
启动 Mermaid Live Editor 服务器（端口 3000）

**参数**: 无

**示例**:
```
使用 start_mermaid_editor 工具启动编辑器
```

### 2. `stop_mermaid_editor`
停止 Mermaid Live Editor 服务器

**参数**: 无

**示例**:
```
使用 stop_mermaid_editor 工具停止编辑器
```

### 3. `open_mermaid`
在浏览器中打开 Mermaid 图表（自动启动编辑器）

**参数**:
- `content` (string, 可选): Mermaid 图表内容
- `file_path` (string, 可选): .mmd 文件路径

**示例**:
```
使用 open_mermaid 工具，参数：
{
  "file_path": "/path/to/diagram.mmd"
}
```

或

```
使用 open_mermaid 工具，参数：
{
  "content": "graph TD\n  A --> B"
}
```

### 4. `check_editor_status`
检查 Mermaid Live Editor 是否正在运行

**参数**: 无

**示例**:
```
使用 check_editor_status 工具检查状态
```

## 使用场景

### 场景 1: 创建图表后自动打开

```
用户: 帮我创建一个流程图
Claude: [创建 diagram.mmd 文件]
Claude: [使用 open_mermaid 工具打开图表]
```

### 场景 2: 编辑现有图表

```
用户: 打开 complete_app_flow.mmd
Claude: [使用 open_mermaid 工具，传入 file_path]
```

### 场景 3: 快速预览

```
用户: 预览这个 Mermaid 代码
Claude: [使用 open_mermaid 工具，传入 content]
```

## 工作原理

1. MCP 服务器通过 stdio 与 Claude Code 通信
2. 当调用 `open_mermaid` 时：
   - 检查编辑器是否运行（检查端口 3000）
   - 如果未运行，自动启动编辑器（`pnpm dev`）
   - 将 Mermaid 内容编码为 base64
   - 构建带参数的 URL
   - 在浏览器中打开 URL
3. 编辑器在后台运行，可以随时打开新图表

## 故障排除

### 端口已被占用
如果端口 3000 已被占用，MCP 服务器会检测到并报告编辑器已在运行。

### 编辑器启动失败
- 确保 Mermaid Live Editor 已安装在 `/Users/px/Documents/freelancer/jin/mermaid-live-editor`
- 确保已运行 `pnpm install`
- 检查 Node.js 版本是否兼容

### 浏览器未打开
- 确保 macOS 的 `open` 命令可用
- 手动复制 URL 到浏览器

## 开发

修改 `index.js` 中的配置：

```javascript
const MERMAID_EDITOR_PATH = '/path/to/your/mermaid-live-editor';
const MERMAID_PORT = 3000;
```

## 许可证

MIT