JinDaGe - mcp_excalidraw MCP Details

article

README

🚀 Excalidraw MCP 服务器：强大的绘图 API，支持 LLM 集成

Excalidraw MCP 服务器是一个功能全面的模型上下文协议（MCP）服务器，它实现了与 Excalidraw 图表和插画的无缝交互。该服务器为大型语言模型 (LLMs) 提供了结构化且易于开发者使用的 API，可用于创建、修改、查询和操作 Excalidraw 绘图。

🚀 快速开始

Excalidraw MCP 服务器为开发者提供了便捷的方式与 Excalidraw 进行交互。通过其 API，开发者可以轻松地在 Excalidraw 中进行绘图操作。

✨ 主要特性

完整的 Excalidraw 元素控制：支持创建、更新、删除和查询任意 Excalidraw 元素。
高级元素操作：支持对齐、分发、锁定和解锁元素。
资源管理：可访问并修改场景信息、库、主题和元素。
轻松集成：与 Claude Desktop 和其他 LLM 平台兼容。
Docker 集成：支持通过 Docker 进行部署。

📦 安装指南

Docker 部署

拉取镜像

docker pull excalidraw/mcp-server:latest

启动容器

docker run -p 8080:8080 --name excalidraw-mcp excalidraw/mcp-server:latest

💻 使用示例

基础用法

创建矩形元素

{
  "type": "rectangle",
  "x": 100,
  "y": 100,
  "width": 200,
  "height": 100,
  "backgroundColor": "#ffffff",
  "strokeColor": "#000000",
  "strokeWidth": 2,
  "roughness": 1
}

查询特定元素

{
  "type": "rectangle",
  "filter": {
    "strokeColor": "#000000"
  }
}

组合多个元素

{
  "elementIds": ["elem1", "elem2", "elem3"]
}

📚 详细文档

API 工具参考

创建矩形元素示例

{
  "type": "rectangle",
  "x": 100,
  "y": 100,
  "width": 200,
  "height": 100,
  "backgroundColor": "#ffffff",
  "strokeColor": "#000000",
  "strokeWidth": 2,
  "roughness": 1
}

查询特定元素示例

{
  "type": "rectangle",
  "filter": {
    "strokeColor": "#000000"
  }
}

组合多个元素示例

{
  "elementIds": ["elem1", "elem2", "elem3"]
}

集成指南

与 Claude Desktop 的集成

在 config.json 文件中添加以下配置：

{
  "excalidrawMCP": {
    "enabled": true,
    "serverUrl": "http://localhost:8080"
  }
}

与 Cursor 的集成

创建一个 .mcp.json 配置文件，内容如下：

{
  "integrations": {
    "excalidrawMCP": {
      "enable": true,
      "options": {
        "serverHost": "localhost",
        "port": 8080
      }
    }
  }
}

注意事项

⚠️ 重要提示

确保服务器地址和端口配置正确。

查看完整的集成文档以获取更多详细信息。

配置选项

| 属性 | 详情 | |------|------| | LOG_LEVEL | 设置日志级别，默认为 "info" | | DEBUG | 启用调试模式，默认为 "false" | | DEFAULT_THEME | 设置默认主题，默认为 "light" |

📄 许可证

此 Excalidraw MCP 服务器根据 MIT 许可证发布。您可免费使用、修改和分发该软件，但需遵守 MIT 许可证的条款和条件。如需更多详情，请参阅项目仓库中的 LICENSE 文件。

mcp_excalidraw