AI-помощь в разработке
ErisPulse предоставляет два взаимодополняющих способа AI-помощи в разработке, которые позволяют генерировать код на основе последних спецификаций фреймворка:
- Документация материалов: большой Markdown-файл, загружаемый в контекст за один раз, подходит для разработки целого проекта
- MCP-сервер: позволяет AI по запросу извлекать официальную документацию, подходит для повседневного завершения кода и поиска API
| Документация материалов | MCP-сервер | |
|---|---|---|
| Формат | Большой Markdown-файл, загружаемый за один раз | AI по запросу извлекает |
| Стоимость контекста | Высокая (занимает токены) | Низкая (извлекаются только соответствующие фрагменты) |
| Актуальность | Обновляется с выпуском версии | В реальном времени (извлекается из GitHub + кэширование) |
| Подходит для | Большой контекстный окно, разработка целого проекта | Повседневное завершение кода, поиск API |
| Клиент | Любой AI-инструмент | Только клиенты, поддерживающие MCP |
Оба метода не исключают друг друга: при разработке крупного проекта можно использовать их одновременно — документация материалов в качестве основы, а MCP-сервер для поиска недостающих элементов.
Документы с материалами
Документы с материалами находятся в каталоге prompts/ и делятся на три типа по сценариям разработки:
| Документ | Сценарий | Описание |
|---|---|---|
| ErisPulse-ModuleDev.md | Разработка модулей | Охватывает весь процесс разработки модулей (обработка событий, маршрутизация, жизненный цикл и т.д.) |
| ErisPulse-AdapterDev.md | Разработка адаптеров | В дополнение к разработке модулей включает ключевые концепции адаптеров, SendDSL, руководство по адаптации платформ |
| ErisPulse-Full.md | Полнстековый справочник | Всё вышеперечисленное + полный комплект руководства пользователя и справочника API |
Способ получения: из каталога prompts/ ветки docs-generated (обновляется синхронно с документацией), либо скачать со страницы «AI-ассистированная разработка» на официальном сайте.
Способ использования
- Выберите документ в соответствии с целью (модули →
ModuleDev, адаптеры →AdapterDev, сложные задачи →Full) - Предоставьте содержимое документа ИИ в качестве контекста: в IDE — поместите в рабочую область, в чатах — вставьте напрямую, при вызовах API — внедрите как system message
- Опишите требования с помощью шаблонов ниже — чем конкретнее, тем выше качество генерации
Шаблон описания требований
Модуль:
На основе спецификации разработки модулей ErisPulse сгенерируйте полный код модуля [название модуля].
Описание функциональности: [основные функции]
События для прослушивания: [сообщения / команды / уведомления / запросы], логика обработки: [действия]
Необходимые параметры конфигурации: [имя ключа]: [назначение] ([обязательный/необязательный], значение по умолчанию: [значение])
Прочие требования: [дополнительные ограничения]
Адаптер:
На основе спецификации разработки адаптеров ErisPulse сгенерируйте полный код адаптера [название адаптера].
Информация о платформе: [название], протокол связи: [WebSocket / WebHook / HTTP-опрос], документация API: [адрес]
Преобразование событий: событие платформы [тип] → маппинг OneBot12 [соответствие]
Методы отправки для реализации: [Text / Image / Voice ...]
Параметры конфигурации: [имя ключа]: [назначение] ([обязательный/необязательный])
Полный пакет документации
skills.zip содержит все оригинальные документы данного языка в одном архиве (без объединения и переработки); в корневом каталоге прилагается общий индекс README: документы сгруппированы по каталогам, и для каждого документа указано, «когда его нужно прочитать». AI может по индексу загружать только необходимые документы.
Отличие от материалов документации
| Материалы документации | Полный пакет документации | |
|---|---|---|
| Форма | Один объединённый файл .md |
Все оригинальные документы + индекс README |
| Способ использования | Полностью загружается в контекст | Распаковать в рабочую область, AI читает документы по мере необходимости |
| Применимость | Достаточный размер контекстного окна, разработка всего проекта | Долговременное размещение в рабочей области, поиск по мере необходимости |
Оба варианта генерируются из одного и того же набора документов и обновляются синхронно.
Получение
Скачайте на странице «AI-ассистированная разработка» официального сайта или возьмите напрямую файл docs/ru/ai-support/skills.zip из ветки docs-generated.
MCP сервер
ErisPulse предоставляет сервер MCP для поиска документации, который позволяет помощникам по написанию кода на ИИ (все, поддерживающие MCP) напрямую искать и просматривать официальную документацию ErisPulse во время написания кода.
Есть два способа подключения: локальный процесс (рекомендуется) или официальная онлайн-точка подключения. Инструментарий одинаков:
| Инструмент | Параметры | Описание |
|---|---|---|
search_docs |
query (обязательный), top_k?=5, lang?=zh-CN |
Поиск по ключевым словам с использованием BM25, можно передать несколько ключевых слов за один раз |
read_document |
doc_path (обязательный), lang?=zh-CN |
Чтение полного Markdown-документа |
list_documents |
lang?=zh-CN |
Вывод всех заголовков, путей и категорий документов в текущем языке |
list_languages |
— | Вывод всех поддерживаемых языков документации и количества документов на каждом |
Поддерживаемые языки: zh-CN / en / zh-TW / ja / ru. Советы по поиску: используйте несколько ключевых слов, а не целые фразы, например, command registration event listener лучше, чем how to register a command.
Способ 1: Локальный процесс (рекомендуется)
После установки запустите локально:
npm i -g @erisdev/mcp-server # Установка глобально → появится команда epsdk-mcp
epsdk-mcp --server # Запуск MCP-сервиса; при первом запуске автоматически загружает документацию в ~/.cache/erispulse-mcp/docs
Также можно запустить без глобальной установки с помощью npx:
npx @erisdev/mcp-server --server
Если у вас есть локальная директория с документацией (без подключения к интернету), укажите её:
ERISPULSE_DOCS_DIR=/path/to/erispulse/docs epsdk-mcp --server
В клиенте MCP настройте ввод/вывод через stdio и стандартные значения (ключ command и args указывают на способ запуска, описанный выше; конкретное расположение и формат настройки смотрите в документации клиента):
{
"command": "epsdk-mcp",
"args": ["--server"]
}
или
{
"command": "npx",
"args": ["@erisdev/mcp-server", "--server"]
}
Способ 2: Официальная онлайн-точка подключения
Если не хотите запускать локальный процесс, подключитесь к официально размещённой точке mcp.erisdev.com. В клиенте MCP настройте HTTP-трансляцию:
{
"url": "https://mcp.erisdev.com/"
}
Сервис публичный, без токена, с ограничением по IP (60 запросов в минуту на IP). Официальная точка может быть отключена в любой момент, для рабочих процессов рекомендуется использовать способ 1 (локальный процесс) или самостоятельное хостинг-размещение.
Часто задаваемые вопросы
Сгенерированный код не соответствует ожиданиям?
Проверьте, предоставлен ли полный документ; добавьте больше деталей в требования (примеры входных/выходных данных, граничные условия); попросите ИИ генерировать пошагово (сначала структуру, затем функциональность); используйте примеры из каталога examples/ в качестве дополнительного контекста.
После подключения MCP ИИ не вызывает search_docs?
Убедитесь, что сервер загружен клиентом (после перезапуска клиента вы увидите, что инструмент стал доступен); в некоторых клиентах необходимо явно указать в промпте «используйте инструмент документации ErisPulse для проверки API».
Далее
- Начало разработки модулей -- полное руководство по ручной разработке модулей
- Начало разработки адаптеров -- полное руководство по ручной разработке адаптеров
- Примеры кода -- примеры уже существующих реализаций модулей и адаптеров
- Модульный конструктор -- визуальный генератор модулей с помощью ИИ в браузере