Гайд · TNWS AI

Как создать workspace custom agent для проверки API-документации в VS Code

Copilot

13 сентября 2026 7 мин—

Создание workspace custom agent GitHub Copilot в .github/agents: Configure Custom Agents, .agent.md, ограниченные tools, готовый профиль и проверка результата.

Задача и применимость

Цель этого руководства — создать версионируемый custom agent, который проверяет API-документацию на соответствие коду и может редактировать только Markdown после явного запроса. Материал рассчитан на командам с OpenAPI или внутренними API-гайдами, которым нужен единый профиль Copilot для всего репозитория. Здесь важен не сам факт появления ответа Copilot, а воспроизводимый результат: понятная конфигурация, ограниченная область действия, контролируемое подтверждение и независимая проверка.

Актуальность интерфейса, имён команд и функций проверена 13 сентября 2026 года по официальной документации GitHub. Тарифы и числовые лимиты намеренно не приводятся: они не нужны для выполнения сценария и могут меняться. Если доступ выдан организацией, итоговое поведение также зависит от политики администратора.

Что подтверждает официальная документация

В VS Code путь начинается с agents dropdown → Configure Custom Agents... → Create new custom agent → Workspace. Профиль создаётся в .github/agents как .agent.md; обязательна description, а tools ограничивает доступ. Проверено 13 сентября 2026 года.

Не переносите названия кнопок из старых скриншотов и не заменяйте команды похожими по смыслу. В автоматизируемом сценарии точное имя — часть контракта. Если интерфейс отличается от описанного, остановитесь и снова откройте источник по ссылке в конце статьи.

Результат, который считаем успешным

Успех проверяется наблюдаемыми признаками. Инструмент доступен в ожидаемой области; тестовая операция выполняется ровно один раз; пользователь понимает, какие данные читаются или изменяются; результат можно перепроверить вне ответа модели. Если хотя бы один признак отсутствует, не переходите к рабочему репозиторию.

Перед началом создайте безопасную тестовую область. Для локальной работы полезны чистый git status, небольшой репозиторий и отсутствие секретов в открытых файлах. Для операций GitHub заранее запишите правильные OWNER/REPO, ожидаемый тип действия и критерий отмены. Это превращает расплывчатую просьбу в проверяемую процедуру.

Готовый .github/agents/api-doc-reviewer.agent.md

Скопируйте заготовку и замените только явно обозначенные данные:

---
name: api-doc-reviewer
description: Проверяет Markdown API-документацию по исходному коду и OpenAPI, предлагает точечные исправления
tools: ["read", "search", "edit"]
target: vscode
---

Сначала найди реализацию маршрута и его тесты. Сравни их с документацией. Не меняй исходный код. Перед редактированием Markdown покажи список расхождений с путями и строками. Не выдумывай параметры, статусы или примеры ответа.

Храните команду или профиль рядом с инструкцией команды, если это не персональный секрет. Токены, cookies и одноразовые коды нельзя помещать в Markdown, chat prompt, issue или git. Перед выполнением перечитайте шаблон как обычный код: какие процессы запускаются, какой ресурс указан и есть ли возможность записи.

Пошаговая настройка

Откройте Copilot Chat в VS Code. В agents dropdown внизу chat view выберите Configure Custom Agents....
Нажмите Create new custom agent, затем выберите Workspace. Этот выбор размещает профиль в .github/agents и делает его частью проекта.
Введите имя файла api-doc-reviewer. VS Code создаст файл с суффиксом .agent.md.
Замените содержимое готовым профилем. Поле description обязательно. Список tools намеренно ограничен чтением, поиском и редактированием.
При необходимости нажмите Configure Tools..., сравните доступные имена инструментов с frontmatter и подтвердите кнопкой OK.
Сохраните файл, вернитесь в chat view и выберите api-doc-reviewer из agents dropdown.
Отправьте тестовый промпт ниже. Первый ответ должен содержать расхождения и доказательства, но не менять файлы до отдельной команды.

После каждого существенного шага фиксируйте простой факт: команда найдена, сервер запущен, профиль выбран, preview совпадает или публичная страница открылась. Не заменяйте такую проверку фразой модели «готово» — она описывает намерение, но не состояние системы.

Готовый промпт

Проверь docs/orders-api.md для POST /orders по реализации и тестам. Верни таблицу: утверждение документации, источник в коде, статус, предлагаемая правка. Пока ничего не редактируй.

Промпт специально задаёт объект работы, границы и формат. В рабочем варианте добавьте критерий остановки: например, «ничего не создавай до подтверждения», «не меняй файлы» или «не выходи за изменённые функции». Для write-действий формулируйте preview и выполнение как два разных хода диалога.

Реалистичный пример входа и ожидаемого результата

Вход: В docs/orders-api.md указан ответ 200, в handler возвращается 201, а тест проверяет JSON с полями id и status.

Ожидаемый результат: Agent находит расхождение 200/201, ссылается на handler и тест, предлагает заменить статус и уточнить пример, но не меняет Markdown без дополнительной команды.

Проверьте результат по первичному артефакту: git diff, списку MCP tools, URL GitHub, состоянию issue или локальным тестам. Если модель уверенно сообщает неподтверждённую версию, право доступа или факт выполнения, считайте это незавершённым шагом. Правильный результат допускает внешнюю проверку.

Как разобрать ответ и принять решение

Сначала отделите факты от рекомендаций. Факт должен иметь опору: путь к файлу, параметр вызова, номер issue, URL, diff или результат команды. Рекомендация может быть полезной, но не должна автоматически расширять задачу. Особенно внимательно проверяйте новые зависимости, изменения прав и команды, которые отправляют данные во внешний сервис.

Затем сравните ответ с исходными границами. Если просили read-only анализ, любое предложение немедленно изменить файл — повод отменить действие. Если разрешили один объект, убедитесь, что tool call не содержит пакетной операции. Если сценарий использует подтверждение, читайте имя инструмента и аргументы, а не только текст кнопки.

Наконец, повторите минимальную проверку без помощи модели. Для локального сценария это обычно git status, git diff и проектные тесты. Для GitHub — открытие прямого URL и сравнение title, body, labels или review comments. Такая тройная сверка обнаруживает частично выполненные операции и ошибки области действия.

Типовые ошибки и диагностика

Если tools опущено, официальный reference говорит, что агент получает все доступные инструменты. Для аудитора это избыточно.
Workspace-профиль коммитится вместе с кодом; его изменения должны проходить review как исполняемые инструкции.
Поле target: vscode делает назначение явным и не обещает одинаковое поведение в GitHub.com.

При сбое не повторяйте write-запрос вслепую: сначала проверьте, не был ли объект уже создан. Для локальной команды сначала выясните фактический путь исполняемого файла. Для MCP посмотрите список серверов, выбранный режим Agent, перечень tools и параметры подтверждения. Для custom agent откройте сам .agent.md и проверьте frontmatter.

Безопасность и командная эксплуатация

Принцип минимальных полномочий здесь практичен: включайте только необходимые tools, открывайте только нужный workspace и не передавайте секреты через prompt. Репозиторные конфигурации MCP и custom agents должны проходить code review, потому что они управляют командами и поведением агента. Персональные профили тоже нужно периодически перечитывать: они действуют в нескольких проектах и легко устаревают.

Разделяйте подготовку и изменение. На первом ходе агент собирает данные и показывает preview, на втором пользователь проверяет целевой ресурс, а на третьем разрешает ровно одно действие. После действия выполняется независимая проверка. Эта последовательность немного длиннее, зато оставляет понятный журнал решений и упрощает откат.

Чек-лист финальной проверки

Использован точный официальный путь, команда или пункт меню, актуальный на 13 сентября 2026 года.
Область действия соответствует задаче: пользователь, workspace, репозиторий или один pull request.
В шаблоне нет токенов, персональных данных, внутренних URL и случайных секретов.
Перед write-действием проверены preview, имя tool и его аргументы.
Операция выполнена не более одного раза и не создала дубль.
Результат подтверждён через git diff, список серверов, тесты или прямой URL.
Неожиданные рекомендации не расширили исходную задачу.
Изменения конфигурации готовы к обычному code review команды.

FAQ

Почему профиль workspace, а не user?

Он хранится в .github/agents, версионируется и используется командой в контексте конкретного репозитория.

Обязательно ли поле name?

Нет, GitHub допускает имя из filename. В примере оно задано явно, чтобы отображение не зависело от переименования файла.

Что обязательно во frontmatter?

Официальная инструкция называет description обязательным. Остальные поля выбираются по задаче, но отсутствие tools расширяет доступ.

Можно ли разрешить MCP tool?

Да, имена MCP-инструментов допускаются в tools, а mcp-servers может задать сервер только для агента. Добавляйте их после отдельной оценки прав.

Официальные первоисточники

Источники и изменяемые детали проверены 13 сентября 2026 года. Перед повторением процедуры после заметного обновления GitHub Copilot или VS Code откройте ссылки снова и сравните имена команд, меню и требования.