Excalidraw MCP Server

Excalidraw MCP Server: мощный API для рисования и интеграции LLM

📣 НОВОСТИ: Версия 1.0.0 теперь опубликована в npm! Вы можете запустить Excalidraw MCP напрямую с помощью npx excalidraw-mcp без установки. Настройка не требуется — просто запустите и наслаждайтесь!

Комплексный сервер Model Context Protocol (MCP), который обеспечивает бесшовное взаимодействие с диаграммами и чертежами Excalidraw. Этот сервер предоставляет LLM (большие языковые модели) возможность создавать, изменять, запрашивать и манипулировать чертежами Excalidraw через структурированный, удобный для разработчиков API.

Быстрый старт

Вы можете запустить сервер Excalidraw MCP напрямую с помощью npx, не устанавливая ничего:

Если вы предпочитаете установить его глобально:

Параметры

Доступны следующие параметры командной строки:

Примечание: следующие параметры в настоящее время полностью функциональны только в версии Docker:

-p, --port <port> Port to run the server on (default: 3000) -h, --host <host> Host to bind the server to (default: localhost) -m, --mode <mode> Transport mode: 'stdio' or 'http' (default: stdio)

Примеры

Запустить с параметрами по умолчанию:

Включить ведение журнала отладки:

Функции

• Полный контроль элементов Excalidraw : создание, обновление, удаление и запрос любого элемента Excalidraw.
• Расширенные возможности управления элементами : группировка, выравнивание, распределение, блокировка и разблокировка элементов.
• Управление ресурсами : доступ и изменение информации о сцене, библиотеках, темах и элементах.
• Простая интеграция : работает с Claude Desktop и другими платформами LLM
• Поддержка Docker : простое развертывание с возможностью контейнеризации

Справочник по инструментам API

Создание и изменение элементов

• создать_элемент
  • Создайте новый элемент Excalidraw (прямоугольник, эллипс, ромб и т. д.)
  • Требуемые входные данные: type , координаты x , y
  • Дополнительные входные данные: размеры, цвета, свойства стиля
• обновить_элемент
  • Обновить существующий элемент Excalidraw по идентификатору
  • Требуемые данные: id обновляемого элемента.
  • Необязательные входные данные: любое свойство элемента для изменения
• удалить_элемент
  • Удалить элемент Excalidraw
  • Требуемый ввод: id удаляемого элемента.
• элементы_запроса
  • Элементы запроса с дополнительной фильтрацией
  • Дополнительные входные данные: type для фильтрации по типу элемента, filter объектов с помощью пар ключ-значение

Управление ресурсами

• получить_ресурс
  • Получить определенный ресурс, например информацию о сцене или всех элементах
  • Требуемые входные данные: тип resource (сцена, библиотека, тема, элементы)

Организация элемента

• group_elements
  • Группировка нескольких элементов вместе
  • Требуемые входные данные: elementIds массив идентификаторов элементов для группировки
• разгруппировать_элементы
  • Разгруппировать группу элементов
  • Требуемый ввод: groupId группы, которую нужно разгруппировать.
• выравнивание_элементов
  • Выровнять несколько элементов на основе указанного выравнивания
  • Необходимые входные данные: массив elementIds и alignment (слева, по центру, справа, сверху, посередине, снизу)
• распределять_элементы
  • Распределяйте элементы равномерно по пространству
  • Необходимые входные данные: массив elementIds и direction (горизонтальное или вертикальное)
• lock_elements
  • Блокировка элементов для предотвращения изменений
  • Требуемые входные данные: массив elementIds элементов для блокировки
• разблокировать_элементы
  • Разблокируйте элементы, чтобы разрешить модификацию
  • Требуемые входные данные: массив elementIds элементов для разблокировки

Интеграция с Claude Desktop

Чтобы использовать этот сервер с приложением Claude Desktop, добавьте следующую конфигурацию в раздел «mcpServers» вашего claude_desktop_config.json :

Интеграция с курсором

Чтобы использовать этот сервер с приложением Cursor, добавьте следующую конфигурацию в раздел «mcpServers» вашего .cursor/mcp.json :

Интеграция с курсором

Чтобы использовать этот сервер с Cursor, создайте файл .cursor/mcp.json в своей рабочей области со следующей конфигурацией:

Обязательно:

1. Замените /path/to/your/directory на фактический абсолютный путь к вашей установке mcp_excalidraw.
2. Создайте каталог .cursor если он не существует.
3. Убедитесь, что путь к index.js правильный и файл существует.

Интеграция с Докером

Руководство по установке

Установка НПМ

Настройка локального развития

Установка докера

Параметры конфигурации

Сервер можно настроить с помощью следующих переменных среды:

• LOG_LEVEL — Установить уровень ведения журнала (по умолчанию: «info»)
• DEBUG — включить режим отладки (по умолчанию: «false»)
• DEFAULT_THEME — Установить тему по умолчанию (по умолчанию: «светлая»)

Примеры использования

Вот несколько практических примеров использования сервера Excalidraw MCP:

Создание элемента «Прямоугольник»

Запрос определенных элементов

Группировка нескольких элементов

Лицензия

Этот сервер Excalidraw MCP лицензирован по лицензии MIT. Вы можете свободно использовать, изменять и распространять программное обеспечение в соответствии с условиями лицензии MIT. Для получения более подробной информации см. файл LICENSE в репозитории проекта.

Разработка

Клонируйте репозиторий и установите зависимости:

Запустите сервер разработки: