Машиночитаемая документация
Мы публикуем стандартные endpoint’ы llmstxt.org:
Каждая HTML-страница содержит
<link rel="alternate" type="text/markdown">, поэтому AI-краулеры
находят Markdown-версию сами. В меню каждой страницы есть «Copy page» и открытие прямо в
ChatGPT/Claude.
llms-full.txt — большой файл (около мегабайта). Для моделей с небольшим контекстом удобнее
MCP-сервер ниже: ассистент подтянет только нужные страницы.MCP-сервер документации
Агенты с поддержкой Model Context Protocol подключаются напрямую:Быстрый старт с Claude или ChatGPT
Шаг 1 — передайте документацию. Вставьте содержимоеllms-full.txt первым сообщением, или просто дайте
ссылку, если модель умеет ходить по URL, или подключите MCP-сервер.
Шаг 2 — опишите свой стек:
- подпись запроса —
hex(HMAC-SHA256(секрет, "<ts>\n<МЕТОД>\n<путь>\n<тело>")), склейка ровно переводами строк (как подписать запрос); - подпись вебхука сверяется константным по времени сравнением (
hash_equals,hmac.compare_digest,crypto.timingSafeEqual) — никогда==(безопасность вебхуков); - обработчик вебхука идемпотентен: дедуп по
uuid+statusдо зачисления; - прогоните всё в песочнице: dev-store с тестовыми деньгами, симуляцией депозитов
(
POST /v1/sandbox/deposit) и повтором вебхуков — реальные средства для проверки не нужны.
Интеграции с IDE
Cursor
Добавьте документацию как источник docs:Settings → Features → Docs → Add new doc →
https://docs.oblodai.com. Затем в чате:
GitHub Copilot
Copilot Chat умеет читатьllms-full.txt напрямую:
Windsurf / Continue / другие
Любой ассистент с контекстом по URL или вложением файла работает так же: приложитеllms-full.txt
(или подключите MCP) и опишите задачу.
Claude API (свой агент)
Если вы строите собственного агента, который должен помогать с интеграцией Oblodai — подключите MCP-сервер документации или вставьтеllms-full.txt в системный промпт:
Промпты, которые работают хорошо
Полная бэкенд-интеграция:Лучшие практики
- Начинайте с
llms-full.txtили MCP — там нет HTML-шума, только содержание. - Чётко описывайте стек — фреймворк, версия языка, ORM.
- Просите тесты — AI хорошо генерирует unit-тесты для логики подписи.
- Перепроверяйте ветки ошибок — AI их иногда пропускает; сверьтесь с каталогом ошибок.
- Код подписи ревьюйте руками — это единственная часть, которую обязательно сделать точно.
- Гоняйте в песочнице до прода — dev-store покрывает весь цикл: платежи, недоплаты, выплаты, вебхуки (тестирование).
- API меняется — документация обновляется сама (спека генерируется из кода), поэтому при
повторном заходе просто перечитайте
llms-full.txtзаново.