内容
# 工具列表
## 特性
- 使用 Eraser.io 的 API 在 Eraser.io 上创建图表
- 支持多种图表类型（时序图、流程图、云架构图、实体关系图）
- 返回用于查看和编辑图表的直接链接
- 在创建图表前验证图表语法
- 自动修复常见的语法错误
- 与 Claude Desktop 的 Docker 集成简单
## 快速设置
### 1. 获取 Eraser.io API 密钥
在 [Eraser.io](https://app.eraser.io) 上注册并从帐户设置中获取您的 API 密钥。
### 2. 构建 Docker 镜像
克隆此存储库并构建 Docker 镜像：
```bash
git clone <repository-url>
cd eraser-mcp
./scripts/build-claude-docker.sh
```
### 3. 配置 Claude Desktop
将此配置添加到您的 Claude Desktop 设置文件中：
**配置文件位置：**
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
- **Linux**: `~/.config/Claude/claude_desktop_config.json`
**配置：**
```json
{
"mcpServers": {
"eraser": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e", "ERASER_API_KEY=yourapikey",
"eraser-mcp:claude"
]
}
}
}
```
### 4. 重启 Claude Desktop
保存配置文件后，完全退出并重启 Claude Desktop。
### 5. 测试集成
在 Claude Desktop 中，尝试询问：
- “创建一个显示登录过程的时序图”
- “能否验证此流程图语法？”
### 6. 创建 Claude Desktop 项目（可选）
为了更好地组织和持久访问图表语法参考，请创建一个专用项目：
1. **在 Claude Desktop 中创建新项目**，单击侧边栏中的“+”图标
2. **命名您的项目**（例如，“Eraser 图表”或“系统架构”）
3. **添加语法指南**，将 [图表语法文档](CLAUDE_DESKTOP_PROJECT_INSTRUCTIONS.md) 上传或复制到您的项目知识库
**使用项目的优势：**
- 持久访问图表语法文档
- 图表创建的上下文感知辅助
- 所有架构图表的有序工作区
- 自定义指令确保一致的图表格式
现在，您可以在此项目中与 Claude 聊天，它将自动使用 Eraser MCP 工具，并全面了解所有图表类型的正确语法。
## 可用工具
### create_diagram
在 Eraser.io 上创建新的图表，并返回用于查看和编辑它的链接。
**参数：**
- `content`（必填）：Eraser DSL 格式的图表内容
- `diagramType`（可选）：图表类型（时序图、云架构图、实体关系图、流程图）。默认值：时序图
- `theme`（可选）：图表主题（浅色、深色）。默认值：深色
- `background`（可选）：是否在渲染图像中包含背景。默认值：true
**返回：**
- 图像 URL：查看/下载渲染的图表图像的直接链接
- 编辑 URL：打开并在 Eraser 中编辑图表的链接
### validate_diagram
验证 Eraser 图表语法并返回发现的任何错误。
**参数：**
- `content`（必填）：要验证的 Eraser DSL 格式的图表内容
- `diagramType`（可选）：要验证的图表类型。默认值：时序图
**返回：**
- 指示图表语法是否有效的验证结果
- 发现的错误和警告列表（如果有）
### fix_diagram
验证并尝试修复 Eraser 图表中的常见语法错误。
**参数：**
- `content`（必填）：要修复的 Eraser DSL 格式的图表内容
- `diagramType`（可选）：要修复的图表类型。默认值：时序图
**返回：**
- 应用的修复列表
- 修复后的图表内容
- 修复后的验证状态
## 示例
### 创建时序图
```
使用以下内容创建一个时序图：
Client > Server: 请求
Server > Database: 查询
Database --> Server: 结果
Server --> Client: 响应
```
### 创建流程图
```
创建一个流程图：
Start [shape: oval]
Start > Process
Process > Decision [shape: diamond]
Decision > End [shape: oval]
```
## 验证功能
服务器包括对所有支持的图表类型的内置验证：
- **时序图**：验证消息格式、激活块和控制结构
- **流程图**：验证节点定义、连接、形状和组
- **实体关系图**：验证实体定义、属性和关系
- **云架构图**：验证服务定义、图标和连接
**自动应用的常见修复：**
- 箭头语法更正（例如，`=>` 到 `>`）
- 缺失的括号和引号
- 删除尾随空格
- 时序消息中缺失的冒号
- 形状名称更正（例如，`circle` 到 `oval`）
## 故障排除
### Docker 镜像未找到
**错误**：`Unable to find image 'eraser-mcp:claude'`
**解决方案**：运行构建脚本：`./scripts/build-claude-docker.sh`
### API 密钥问题
**错误**：服务器报告 API 密钥错误
**解决方案**：检查配置文件中您的 API 密钥是否正确
### 权限问题
**错误**：Docker 权限被拒绝
**解决方案**：确保 Docker 正在运行，并且您的用户具有 Docker 权限
## 开发
对于开发，您可以使用包含的 Dev Container：
1. 使用 Dev Containers 扩展在 VS Code 中打开
2. 修改代码
3. 重建 Docker 镜像：`./scripts/build-claude-docker.sh`
### 开发命令
- `npm install` - 安装依赖项
- `npm run dev` - 运行热重载
- `npm run build` - 将 TypeScript 构建为 JavaScript
- `npm run lint` - 运行 ESLint
- `npm run typecheck` - 运行 TypeScript 类型检查
### 测试
```bash
cd tests
./run-tests.sh
```
## 图表语法文档
有关每种图表类型的详细语法信息，请访问：
- [时序图](https://docs.eraser.io/docs/syntax-2)
- [流程图](https://docs.eraser.io/docs/syntax-3)
- [实体关系图](https://docs.eraser.io/docs/syntax-1)
- [云基础设施](https://docs.eraser.io/docs/syntax)
## 许可证
MIT
MCP 市场