Стартовый набор: AGENTS.md, команды и проверки для копирования

Здесь лежат файлы, которые можно скопировать в свой проект и поправить. У каждого блока кода есть кнопка «Копировать». Названия файлов вынесены в заголовки, чтобы вы знали, как назвать копию. Секретов в наборе нет, и вы тоже не вставляйте в него настоящие ключи.

Что входит в стартовый набор?

Шаблон AGENTS.md, пара примеров команд, пример простой автопроверки и образец подключения MCP-сервера без ключей. Файлы даны для копирования, к ним есть пояснения. Форматы команд и настроек зависят от инструмента, поэтому там, где это важно, мы отсылаем к документации. Ничего лишнего в набор не входит.

Так выглядит папка проекта после копирования:

мой-проект/
├── AGENTS.md              правила для помощника
├── README.md              что это за проект, для людей
├── .gitignore             что не попадает в общий доступ
├── .env.example           пример файла для секретов, без значений
├── .mcp.json              образец подключения сервиса (формат Claude Code)
├── prompts/
│   └── review.md          пример своей задачи-команды
└── scripts/
    └── check.sh           простая автопроверка

Где взять готовый шаблон AGENTS.md?

В стартовом наборе курса есть шаблон AGENTS.md с разделами: что за проект, команды запуска и проверки, стиль, запреты. Скопируйте файл в корень проекта, замените описание и команды на свои и удалите лишние пункты. Шаблон бесплатный, пользуйтесь свободно. Правьте его под свой проект смело.

# Правила проекта

## Что за проект
[Один абзац: что это, для кого, на чём сделано.]

## Как запускать и проверять
- Запуск: [команда]
- Проверка: [команда, например bash scripts/check.sh]
- После каждой правки запускай проверку и покажи результат.

## Стиль
- Отвечай по-русски, коротко и без жаргона.
- Перед правкой скажи, какие файлы собираешься менять.
- Делай маленькие правки, по одной задаче за раз.

## Запреты
- Не открывай и не меняй файл .env и папку secrets/.
- Не удаляй файлы без моего согласия.
- Не добавляй в проект ключи, пароли и личные данные.

## Где что лежит
- [папка]: [что в ней]
- prompts/: готовые задачи
- scripts/: проверки

Сам файл правил подробно разобран в модуле про AGENTS.md.

Как выглядит пример хорошего AGENTS.md?

Короткий файл на одну-две страницы: назначение проекта одним абзацем, три-пять команд, правила стиля, список запретов и места, где лежат важные папки. Без воды и без секретов. В примере ниже комментарии подсказывают, что можно убрать, а что лучше оставить. Начинайте с малого.

Ниже учебный пример для вымышленного проекта: сайт-визитка небольшой пекарни. Комментарии после знака # убирать не нужно, это пояснения.

# Правила проекта

## Что за проект
Сайт-визитка пекарни «Хлебный двор» (учебный пример). Статический сайт: HTML и CSS, без серверной части.

## Как запускать и проверять
- Запуск: открыть index.html в браузере.
- Проверка: bash scripts/check.sh   # оставьте, помощник должен проверять сам себя
- После каждой правки запускай проверку и покажи результат.

## Стиль
- Тексты на сайте по-русски, короткие предложения.   # у вас может быть другое
- Перед правкой скажи, какие файлы будешь менять.

## Запреты
- Не трогай файлы в папке photos/.   # важное: то, что нельзя ломать
- Не меняй телефон и адрес без моей просьбы.

## Где что лежит
- index.html: главная
- menu/: страница с меню
- css/style.css: оформление

Остальные файлы набора

prompts/review.md: пример своей задачи

Идея простая: часто повторяющуюся просьбу кладут в файл и вызывают одной фразой. Так работает у любого инструмента. Некоторые инструменты умеют ещё и настоящие команды с косой чертой, но у каждого свой формат файла, его смотрите в документации и в модуле про навыки и команды.

# Задача: проверить мои изменения

Посмотри все несохранённые изменения проекта.
1. Найди ошибки и лишние правки.
2. Проверь, что в изменениях нет ключей, паролей и личных данных.
3. Выведи список замечаний по файлам, ничего не исправляй.

Вызов: скажите помощнику «выполни задачу из файла prompts/review.md».

scripts/check.sh: простая автопроверка

Скрипт запускают после правок помощника. В этом примере он проверяет одно: файл с секретами не попал под контроль версий. Свои проверки (тесты, сборку) добавьте строками ниже. Подключать такие проверки автоматически к действиям помощника можно хуками, если они есть в вашем инструменте: смотрите модуль про хуки.

#!/usr/bin/env bash
# Простая автопроверка. Запуск: bash scripts/check.sh
set -e

# Файл .env не должен быть под контролем версий
if git ls-files --error-unmatch .env >/dev/null 2>&1; then
  echo "Ошибка: файл .env попал под контроль версий"
  exit 1
fi

# Сюда добавьте свои проверки, например запуск тестов:
# npm test

echo "Проверка пройдена"

.mcp.json: образец подключения сервиса

MCP подключает к помощнику внешний сервис. Файл ниже в формате Claude Code. Это образец формы: название сервера и пакет вымышленные, а формат файла и название пакета проверьте в документации вашего инструмента (проверьте актуальную версию и название). В других инструментах подключение выглядит иначе, подробнее в модуле про MCP. Обратите внимание: ключа в файле нет, только ссылка на переменную окружения.

{
  "mcpServers": {
    "my-service": {
      "command": "npx",
      "args": ["-y", "example-mcp-server"],
      "env": {
        "SERVICE_API_KEY": "${SERVICE_API_KEY}"
      }
    }
  }
}

.env.example и .gitignore: секреты у вас

# Скопируйте этот файл в .env и впишите свои значения.
# Файл .env в общий доступ не попадает.
SERVICE_API_KEY=

.env
secrets/

Как подключить набор к своему проекту?

Скопируйте файлы в корень проекта, откройте их в редакторе, замените описание и команды, затем запустите ИИ-помощника и попросите пересказать правила. Если пересказ верный, файлы прочитаны. Секреты в набор не кладите: ключи храните отдельно. После подключения проверьте работу на небольшой задаче и поправьте формулировки, если агент понял правила не так.

Проверочный промпт для пересказа:

Перечисли правила проекта из AGENTS.md своими словами и скажи, какой командой запускать проверку.

Подходит ли набор для разных инструментов?

Файл AGENTS.md читают многие инструменты, а форматы команд и настроек у каждого свои. В наборе общая часть вынесена отдельно, а специфичные примеры подписаны названием инструмента. Если ваш инструмент не читает AGENTS.md, в документации есть способ подключить файл. Проверьте это при первом запуске.

Общая часть: AGENTS.md, prompts/review.md, scripts/check.sh, .env.example, .gitignore. Зависит от инструмента: .mcp.json (образец для Claude Code). Если вы поделились набором с коллегами, загляните в модуль про общие наборы.