简体中文 English 繁體中文 日本語 Русский
本文为静态镜像，内容以交互版为准 在交互式文档中心打开 →

AI-помощь в разработке

ErisPulse предоставляет два взаимодополняющих способа AI-помощи в разработке, которые позволяют генерировать код на основе последних спецификаций фреймворка:

Документация материалов MCP-сервер
Формат Большой Markdown-файл, загружаемый за один раз AI по запросу извлекает
Стоимость контекста Высокая (занимает токены) Низкая (извлекаются только соответствующие фрагменты)
Актуальность Обновляется с выпуском версии В реальном времени (извлекается из GitHub + кэширование)
Подходит для Большой контекстный окно, разработка целого проекта Повседневное завершение кода, поиск API
Клиент Любой AI-инструмент Только клиенты, поддерживающие MCP

Оба метода не исключают друг друга: при разработке крупного проекта можно использовать их одновременно — документация материалов в качестве основы, а MCP-сервер для поиска недостающих элементов.

Документация по материалам

Документация по материалам находится в каталоге prompts/ и разделена на три типа в зависимости от сценария разработки:

Документ Сценарий Описание
ErisPulse-ModuleDev.md Разработка модуля Охватывает весь процесс разработки модуля (обработка событий, маршрутизация, жизненный цикл и т.д.)
ErisPulse-AdapterDev.md Разработка адаптера Дополняет разработку модуля, включая основные концепции адаптера, SendDSL и руководство по адаптации к платформе
ErisPulse-Full.md Полное руководство Все вышеперечисленное + полное руководство пользователя и сводка API

Способы получения: получите напрямую из каталога prompts/ (документация обновляется синхронно), или скачайте нужную версию с GitHub Releases.

Способы использования

  1. Выберите нужный документ в зависимости от цели (модуль → ModuleDev, адаптер → AdapterDev, сложные задачи → Full)
  2. Передайте содержимое документа в качестве контекста ИИ: поместите в рабочую область IDE, вставьте в диалог, или добавьте в системное сообщение при вызове API
  3. Используйте приведенные ниже шаблоны для описания задачи, чем конкретнее описание, тем выше качество генерации

Шаблон описания задачи

Модуль:

Пожалуйста, на основе спецификации разработки модуля ErisPulse, сгенерируйте полный код модуля [Название модуля].

Описание функции: [Основная функция]
События, которые нужно отслеживать: [Сообщение / Команда / Уведомление / Запрос], логика обработки: [Операция]
Необходимые параметры конфигурации: [Ключ]: [Назначение] ([Обязательный/Необязательный], значение по умолчанию: [Значение])
Дополнительные требования: [Дополнительные ограничения]

Адаптер:

Пожалуйста, на основе спецификации разработки адаптера ErisPulse, сгенерируйте полный код адаптера [Название адаптера].

Информация о платформе: [Название], протокол связи: [WebSocket / WebHook / Опрос HTTP], документация API: [Адрес]
Конвертация событий: Платформенное событие [Тип] → Отображение OneBot12 [Отношение]
Необходимо реализовать методы отправки: [Текст / Изображение / Голос ...]
Параметры конфигурации: [Ключ]: [Назначение] ([Обязательный/Необязательный])

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».

Далее