Перейти к основному содержимому

Сценарий 01: знакомство с незнакомой кодовой базой

Составьте карту незнакомого проекта с помощью CodeGraph. Проверьте найденные компоненты, точки входа и зависимости по исходникам.

Руководства

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

Быстрый старт

Настройте подключение к CodeGraph и проверьте команды репозитория по руководству OpenCode. Затем вернитесь к этому сценарию, чтобы составить первичную карту проекта.

Нужны подключение OpenCode к MCP CodeGraph и установленная команда onboard. Её определение находится в .opencode/commands/onboard.md; установка OpenCode сама по себе не добавляет команду. Проверьте, что активное подключение CodeGraph относится к нужному проекту, затем откройте репозиторий и выполните:

/onboard

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

Что проверяет сценарий

Команда последовательно собирает контекст проекта:

  1. codegraph_project_context_status показывает, пригоден ли контекст проекта.
  2. codegraph_project_context_sync_status сообщает об ожидающей или устаревшей синхронизации.
  3. codegraph_context_session_open открывает или повторно использует явную контекстную сессию.
  4. codegraph://project/context возвращает обнаруженные метаданные проекта и языки.
  5. codegraph_context_retrieval_evidence_fetch и codegraph_context_retrieval_fused_search находят свидетельства об архитектуре и документации.
  6. codegraph_context_retrieval_file_read читает только фрагменты исходников, необходимые для проверки утверждения.

codegraph_digital_employee_skill_search подбирает подсказку для знакомства с проектом. Найденные компоненты и точки входа команда проверяет по исходникам.

Передайте непустой session_id в codegraph_context_session_open или используйте уже открытую сессию этой работы. Сервер связывает собранный контекст с этим идентификатором. Если вызов возвращает ошибку, выполните указанное в ответе действие и повторите открытие.

Сначала оцените режим готовности

Прочитайте фактические readiness_mode, причину и следующее действие, которые вернул сервер. Таблица описывает частые результаты; устаревание или блокировка могут отражаться в других полях статуса.

Сначала оцените режим готовности
Режим Что он означает Следующее действие
ready Контекст проекта и необходимые источники свидетельств доступны. Задавайте точечные вопросы и переходите к адресному чтению исходников.
sync_pending Проекция контекста ещё не догнала рабочую копию. Зафиксируйте состояние и дождитесь либо запустите документированную синхронизацию.
graph_only Структурный граф доступен, но семантический контекст или память недоступны. Используйте только ограниченные графовые факты и явно обозначьте отсутствие семантического контекста.
Устаревший или заблокированный контекст Сервер сообщает, что контекст нужно обновить или восстановить. Укажите блокер и следующий шаг из ответа сервера, затем выполните предложенное действие восстановления.

Каким должен быть результат

После знакомства другой инженер должен понимать:

  • какие каталог и границы проекта обнаружил CodeGraph;
  • какие языки и крупные подсистемы подтверждены свидетельствами;
  • какие стартовые пути или точки входа действительно проверены;
  • в каком режиме готовности получен ответ и какие ограничения из этого следуют;
  • какие выводы подтверждены исходниками, а какие остаются неизвестными;
  • какое минимальное следующее исследование сильнее всего уменьшит неопределённость.

Используйте карту для выбора следующего шага. Откройте ссылку на точку входа, проследите вызов до интересующего компонента и задайте вопрос об этой связи. Так вы переходите от обзора проекта к конкретному участку кода.

Как продолжить исследование

Если в репозитории несколько продуктов, выберите один пользовательский путь или компонент. Например: «Где начинается обработка HTTP-запроса на создание заказа и какие компоненты она вызывает?» Подставьте действие из вашего проекта. В ответе проверьте названия файлов, функции и связи по указанным ссылкам. Затем переходите к исследованию зависимостей, ревью или аудиту выбранной области.

Связанные материалы

После знакомства используйте аудит безопасности для ограниченной проверки или разработку функции, когда область реализации уже согласована.