Документация/Настройка
Правила проекта: AGENTS.md и заметка о репозитории
Расскажите агенту один раз, как собирать проект и чего не трогать: файлом AGENTS.md в репозитории или заметкой в настройках.
Чтобы не объяснять в каждом чате, как собирать и тестировать проект и какие папки трогать нельзя, запишите это один
раз. Способов два. Файл AGENTS.md лежит в репозитории, и его получат все, кто работает с проектом. Заметку о
репозитории вы пишете в настройках, и она остаётся только у вас. Оба текста уходят модели с каждым запросом.
AGENTS.md агент перечитывает перед каждым запросом, поэтому правка файла действует со следующего запроса, даже в
открытом чате. Заметка закрепляется за чатом при первом запросе, поэтому её правка действует в новых чатах.
AGENTS.md
AGENTS.md — обычный Markdown-файл в корне проекта. Обязательных полей и разделов в нём нет. Если файл есть, агент
получает его текст в каждом запросе как правила проекта. Включать ничего не нужно.
Как создать
- Создайте в корне проекта файл
AGENTS.mdи напишите правила. Или наберите в поле ввода/init— агент изучит проект и составит файл сам. Описание команды/initв списке «/» пока на английском. - Проверьте, что агент видит файл. Под полем ввода справа, рядом с моделью и режимом, стоит кружок контекста: он заполняется вместе с окном контекста (Контекст и расход). Нажмите на него и в карточке «Контекст агента» найдите строку «Правила · AGENTS.md»: зелёная точка — файл найден, серая — файла нет или он пуст.
- Чтобы поправить правила, нажмите на эту строку — файл откроется во вкладке редактора.
Что написать
Пишите коротко: команды сборки и тестов, договорённости, принятые в проекте, и что нельзя менять. Например:
# Правила проекта
## Сборка и тесты
- Собрать: `npm run build`
- Тесты: `npm test` — запускай после каждой правки
## Договорённости
- Код на TypeScript, без `any`
- Новый метод API — только вместе с тестом
## Не трогать
- `migrations/` — эти миграции уже применены в рабочей базе
Совет
Не повторяйте в AGENTS.md то, что агент и так увидит в коде. Файл уходит модели в каждом запросе: чем он
короче, тем меньше места занимает в контексте.
Важно
Не пишите в правила пароли, токены и ключи. Текст уходит модели в каждом запросе.
Правила — не защита
AGENTS.md объясняет агенту, как работать, но запретить ему ничего не может. Если что-то нельзя делать ни при каких
условиях — удалять файлы вне проекта, ходить в сеть, писать в рабочую базу, — запретите это в настройках
безопасности. Как это сделать, читайте на страницах Ограничения агента и
Доступ агента к базам и кластерам.
Заметка о репозитории
Заметка — правила без файла. В git она не попадает, коллеги её не видят. Пишите в неё то, что важно только вам: какой это сервис, куда смотреть в общих базах и очередях, на что обращать внимание.
Как добавить
- Откройте проект.
- Откройте «Настройки → Окружения» в группе «Подключения». Окружение — стенд, общий для нескольких сервисов: базы, брокеры, кластеры. Заметка работает и без окружений: блок «Этот репозиторий» с полем для неё есть, даже когда окружений ещё нет.
- В блоке «Этот репозиторий» заполните поле «Что агенту знать об этом репозитории». Например: «Сервис orders — схема orders, очереди orders.*».
- Нажмите «Сохранить».
Если у репозитория есть окружение, агент получит заметку вместе с ним. Подробнее — на странице Окружения.
Когда заметка начинает действовать
Заметка действует в новых чатах. Чтобы применить её в уже открытом чате, нажмите «Применить к открытой сессии» под блоком «Этот репозиторий». Под кнопкой DevMachine покажет, сколько примерно токенов уйдёт на следующий запрос в этом чате и во сколько раз он дороже обычного. Токены — единицы, в которых модель считает текст. Обычный запрос берёт уже прочитанную историю из кеша, а следующий перечитает её всю заново. Подтвердите кнопкой «Применить» или нажмите «Отмена», если передумали.
Что важно знать
- Заметка хранится на этом компьютере, вне папки проекта.
- Описание окружения и заметка вместе — до 16 000 символов. Под полем заметки есть счётчик. Описание вы пишете в карточке окружения, в поле «Описание»: что агенту знать о стенде.
- Не пишите в заметку пароли: она уходит модели в каждом запросе.
- Агент сам заметку не пишет. Он может предложить текст, но сохраняете его вы.
AGENTS.md или заметка
AGENTS.md | Заметка о репозитории | |
|---|---|---|
| Где хранится | В репозитории, рядом с кодом | На этом компьютере, вне проекта |
| Кто видит | Все, кто работает с репозиторием | Только вы |
| Как править | В редакторе; можно попросить агента | «Настройки → Окружения» |
| Проект на сервере (SSH) | Лежит в проекте на сервере | Пока не работает |
Отдельного файла правил на все проекты в DevMachine нет. Приёмы, нужные во всех проектах, оформите навыком: агент загрузит его, когда возьмётся за подходящую задачу.
Что агент не берёт из репозитория
Если в репозитории лежат свои команды, агенты, MCP-серверы или навыки агента, DevMachine их не загружает — ни из вашего проекта, ни из чужого. Так чужой репозиторий не подсунет агенту свои инструменты. Свои команды, агентов и навыки храните в домашней папке. Подробнее — на страницах Свои команды и агенты и Навыки.
Ограничения
- Заметка о репозитории не доходит до проекта на сервере. В разделе «Окружения» такой проект помечен: «Проект на сервере: его агент работает там, а окружения пока доходят только до проектов на этом компьютере.»
- Текст
AGENTS.mdи заметки уходит модели в каждом запросе через сервер DevMachine, как и всё, что видит агент. Подробнее — на странице Данные и приватность.
Что дальше
- Окружения — общие стенды с базами и кластерами.
- Навыки — инструкции, которые агент берёт по задаче.
- Свои команды и агенты — команды «/» и субагенты из Markdown-файлов.
- Контекст и расход — сколько места занимают правила в контексте.
Обновлено · Нашли неточность? Напишите на support@devmachine.ai или в Telegram.
