Правила для ШІ-асистентів

Claude Code, Codex, Cursor, Copilot та інші асистенти пишуть код краще, коли знають правила роботи з бібліотекою. Ми підготували файли інструкцій, які підключаються до вашого проєкту поруч із наявними правилами — без заміни вашого AGENTS.md чи CLAUDE.md.

Файли

Файл	Для чого	Завантажити
`json-rpc-bundle.md`	Проєкти, що надають API через JsonRpcBundle: як агенту працювати з бібліотекою, правила для процедур, параметрів, результатів, помилок, кешу, версій і груп API, подій, відомі пастки, перевірка результату	json-rpc-bundle.md
`json-rpc-bundle-extensions.md`	Пакети-розширення бандла: точка входу через `RpcExecutor`, токени, групи й версії, маршрути, обмеження компіляції, вимоги до пакета	json-rpc-bundle-extensions.md
`ufo-code-style.md`	Необов'язково: стиль коду команди UFO-Tech — для проєктів, що його приймають	ufo-code-style.md

Файли англійською: асистенти стабільніше виконують англомовні інструкції. Правила написано для версії бандла 10.4.

Як підключити

Покладіть файл у репозиторій, наприклад у docs/ai/:

mkdir -p docs/ai
curl -o docs/ai/json-rpc-bundle.md https://ufo-tech.space/assets/ai/json-rpc-bundle/json-rpc-bundle.md

і додайте посилання на нього у файл інструкцій, який уже є у вашому проєкті:

Асистент	Що додати
Codex, Cursor, Zed та інші з підтримкою AGENTS.md	у ваш `AGENTS.md` рядок: `When working with JSON-RPC procedures, follow docs/ai/json-rpc-bundle.md.`
Claude Code	у ваш `CLAUDE.md` рядок `@docs/ai/json-rpc-bundle.md` (імпорт)
GitHub Copilot	файл `.github/instructions/json-rpc-bundle.instructions.md` з вмістом правил і `applyTo` для каталогу процедур
Cursor (правила проєкту)	файл `.cursor/rules/json-rpc-bundle.mdc` з вмістом правил

Ваші наявні правила лишаються головними: файл бандла не перевизначає стиль чи архітектуру проєкту, а лише описує роботу з бібліотекою.

Що всередині

Як агенту працювати — на початку файлу:

джерело правди — встановлений код бандла у vendor/ і описи релізів у vendor/ufo-tech/json-rpc-bundle/releases/, а не пам'ять моделі;
перевіряти встановлену версію; не вигадувати класи, атрибути, опції; про суперечність правил і коду — повідомляти;
не змінювати публічні RPC-контракти без потреби (несумісні зміни — нова версія API) і не рефакторити поза задачею.

Правила бібліотеки — коротко, з посиланнями на документацію замість пояснень: тонкі процедури, DTO і декларативна валідація, формат результату, помилки, кеш, версії та групи API, події.

Відомі пастки 10.4 — застарілі атрибути й події, #[RPC\DTOCollection] на методі, ttl для #[RPC\Lock], особливості подій для Messenger і помилок HTTP (див. Актуальні помилки).

Перевірка перед завершенням — тести, виклик зміненого методу, схема в GET /rpc.

Файл навмисно не пояснює, як працюють механізми, — для цього є документація, на яку він посилається. Так інструкція лишається короткою і не перетворюється на другу копію документації, яка з часом розійдеться з першою.