excalidraw-mcp

🚀 Excalidraw MCP 服务器

本服务器为 Excalidraw 提供模型上下文协议（MCP）服务，具备用于操作 Excalidraw 绘图的 API 功能，能帮助用户轻松管理和导出绘图。

🚀 快速开始

Excalidraw MCP 服务器为 Excalidraw 提供了强大的 MCP 服务和操作 API。以下是快速启动服务器的步骤：

# 克隆仓库
git clone https://github.com/yourusername/excalidraw-mcp.git
cd excalidraw-mcp

# 安装依赖项
npm install

# 构建项目
npm run build

# 启动服务器
npm start

✨ 主要特性

• 绘图操作：支持创建、读取、更新和删除 Excalidraw 绘图。
• 格式导出：可将绘图导出为 SVG、PNG 和 JSON 格式。
• 存储系统：采用简单的基于文件的存储系统。

📦 安装指南

# 克隆仓库
git clone https://github.com/yourusername/excalidraw-mcp.git
cd excalidraw-mcp

# 安装依赖项
npm install

# 构建项目
npm run build

💻 使用示例

基础用法

启动服务器：

npm start

高级用法

API 端点

该服务器提供以下工具：

绘图管理

• create_drawing：创建一个新的 Excalidraw 绘图
• get_drawing：通过 ID 获取一个 Excalidraw 绘图
• update_drawing：通过 ID 更新一个 Excalidraw 绘图
• delete_drawing：通过 ID 删除一个 Excalidraw 绘图
• list_drawings：列出所有 Excalidraw 绘图

导出操作

• export_to_svg：将 Excalidraw 绘图导出为 SVG
• export_to_png：将 Excalidraw 绘图导出为 PNG
• export_to_json：将 Excalidraw 绘图导出为 JSON

📚 详细文档

项目结构

excalidraw-mcp/
├── src/
│   ├── common/
│   │   └── errors.ts
│   └── operations/
│       ├── drawings.ts
│       └── export.ts
├── index.ts
├── package.json
├── tsconfig.json
└── README.md

构建

npm run build

开发模式下运行

npm run dev

📄 许可证

本项目采用 MIT 许可证。