1c Edt Tools

1C:EDT MCP Tools — Reference Guide

MCP-сервер 1c-edt предоставляет прямой доступ к семантическому индексу EDT (BM model), платформенной документации, проверкам и управлению проектом. Все инструменты работают через живой экземпляр EDT и используют реальный AST/семантику, а не текстовый поиск.

When to Use

Используй инструменты 1c-edt когда:

• Нужно прочитать исходный код модуля или отдельного метода
• Нужно понять структуру модуля (список процедур/функций) без чтения всего файла
• Нужно найти все вызывающие места метода (call hierarchy)
• Нужно найти все ссылки на объект метаданных (references)
• Нужно проверить ошибки проекта или конкретного объекта
• Нужна документация по типам платформы (ТаблицаЗначений, Массив и т.д.)
• Нужно получить автодополнение (content assist) в конкретной позиции кода
• Нужно найти код по тексту/регулярному выражению во всех модулях
• Нужно получить свойства объектов метаданных или конфигурации
• Нужно обновить базу данных или запустить отладку

Prerequisites Check

Перед первым использованием любого инструмента проверь доступность MCP-сервера — вызови любой инструмент EDT-MCP (например get_edt_version). Если сервер не отвечает — сообщи пользователю:

EDT MCP сервер недоступен. Для использования инструментов анализа кода необходимо:

1. Запустить 1C:EDT с открытым workspace
2. Убедиться, что плагин EDT MCP Server установлен и активен (порт 8765)

Не пытайся вызывать инструменты без работающего сервера.

Important

• Параметр projectName — имя проекта в EDT workspace (например РНК_ЕРПУХ или РНК_ЕРПУХ.Расширение1)
• Параметр modulePath — путь относительно папки src/ проекта (например CommonModules/Пользователи/Module.bsl)
• Параметр objectFqn — полное квалифицированное имя (например Document.SalesOrder, Catalog.Products, CommonModule.Common). Поддерживает русские имена типов: Справочник.Номенклатура, Документ.ЗаказКлиента, ОбщийМодуль.ОбщегоНазначения
• Все инструменты требуют предварительной загрузки через ToolSearch с запросом select:mcp__1c-edt__<tool_name>

Tools by Category

1. Code Reading, Navigation and Editing

read_module_source — Чтение исходного кода модуля

Читает весь BSL-файл или диапазон строк. Возвращает код с номерами строк.

Совет: Для больших модулей используй startLine/endLine вместо чтения целиком.

write_module_source — Запись BSL-кода в модуль

Записывает BSL-код в модули объектов метаданных с автоматической проверкой синтаксиса. Поддерживает три режима: поиск и замена фрагмента, полная замена модуля, добавление в конец. Модуль можно указать либо через modulePath, либо через objectName + moduleType.

Преимущество: автоматическая проверка синтаксиса после записи — ошибки обнаруживаются сразу.

read_method_source — Чтение одного метода

Извлекает код конкретной процедуры/функции по имени. Не нужно читать весь модуль.

get_module_structure — Структура модуля

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

get_method_call_hierarchy — Иерархия вызовов (callers/callees)

Находит вызывающие (callers) или вызываемые (callees) методы через семантический индекс EDT (AST, не текстовый поиск). Аналог Call Hierarchy в IDE.

go_to_definition — Переход к определению символа

Навигация к определению метода или объекта метаданных. Обратная операция к find_references: вместо поиска использований — находит, где символ определён. Поддерживает русские имена типов метаданных.

get_symbol_info — Информация о символе в позиции кода

Получает type/hover информацию о символе в конкретной позиции BSL-файла — то же, что EDT показывает при наведении мыши. Полезно для понимания типов переменных в динамически типизированном BSL.

Возвращает: имя символа, тип (Function/Procedure/Parameter и др.), сигнатуру, параметры, документацию.

list_modules — Список модулей

Перечисляет все BSL-модули объекта или всего проекта (МодульОбъекта, МодульМенеджера, МодулиФорм и т.д.).

ai_context - Агрегированный контекст объекта

Собирает в одном вызове metadata, список BSL-модулей и структуру модуля. Заменяет последовательность get_metadata_details + list_modules + get_module_structure одним запросом - экономит round-trips. Поддерживает уровни детализации.

Совет: Используй перед тем как начать доработку объекта - один вызов вместо трех.

diff_module - Сравнение модуля с VCS

Показывает что изменилось в BSL-модуле по сравнению с предыдущей версией в git: добавленные/измененные/удаленные методы, построчный diff. Критично для code review.

Новый файл: если модуль не в VCS - вернет isNewFile: true и список всех методов как добавленных.

2. Code Search

search_in_code — Полнотекстовый поиск по коду

Поиск по всем BSL-модулям конфигурации. Поддерживает текст и regex, регистрозависимость, контекстные строки, фильтрацию по пути и типу метаданных.

get_content_assist — Автодополнение кода

Получает предложения автодополнения в конкретной позиции BSL-файла. Открывает файл в редакторе EDT.

3. Metadata Inspection

get_metadata_objects — Список объектов метаданных

Возвращает Name, Synonym, Comment, Type, наличие модулей. Поддерживает фильтрацию.

get_metadata_details — Детальные свойства объектов

Возвращает полные свойства объектов метаданных (реквизиты, ТЧ, формы, макеты и т.д.).

find_references — Поиск ссылок на объект метаданных

Находит все места использования объекта: в других метаданных, в BSL-коде с номерами строк, формах, ролях, подсистемах. Работает только для top-level объектов.

rename_metadata_object — Переименование с рефакторингом

Переименовывает объект метаданных или реквизит с каскадным обновлением всех ссылок: BSL-код, формы, метаданные. Работает в режиме preview + confirm.

Workflow: первый вызов без confirm → просмотр изменений → второй вызов с confirm=true. Через disableIndices можно исключить отдельные изменения.

delete_metadata_object — Удаление с очисткой ссылок

Удаляет объект метаданных или реквизит с очисткой ссылок. Работает в режиме preview + confirm.

add_metadata_attribute — Добавление реквизита

Добавляет новый реквизит к объекту метаданных (справочник, документ, регистр и др.) через EDT.

get_configuration_properties — Свойства конфигурации

Имя, синоним, комментарий, вариант скрипта, режим совместимости и т.д.

4. Platform Documentation

get_platform_documentation — Документация платформы

Документация по типам, методам, свойствам и встроенным функциям платформы 1С. Поддерживает русские и английские имена.

5. Error Checking and Validation

get_problem_summary — Сводка проблем

Количество проблем по проектам и уровням серьёзности (ERRORS, BLOCKER, CRITICAL, MAJOR, MINOR, TRIVIAL).

get_project_errors — Детальные ошибки проекта

Возвращает код проверки, описание, расположение объекта, уровень серьёзности. Фильтрация по объектам, серьёзности, ID проверки.

get_check_description — Описание проверки EDT

Markdown-описание проверки: объяснение, примеры, как исправить.

revalidate_objects — Перевалидация объектов

Запускает повторную валидацию проекта или конкретных объектов.

validate_query — Валидация запросов 1С

Проверяет текст запроса в контексте проекта — синтаксис и семантика. Поддерживает режим СКД (DCS).

clean_project — Очистка проекта

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

6. Form Inspection and Editing

get_form_screenshot — Скриншот формы

Получает PNG-скриншот формы из WYSIWYG-редактора EDT. Возвращает изображение как embedded resource. Без параметров — снимает скриншот текущего открытого редактора формы.

Примечание: Нестабильно — иногда возвращает чёрное изображение. Попробовать refresh: true или перезапустить EDT.

edit_form - Редактирование управляемой формы

Добавляет или удаляет элементы формы (поля, группы, кнопки, таблицы, декорации) через BM API без ручного редактирования Form.xml. Шесть операций: addField, addGroup, addButton, addTable, addDecoration, removeItem + help для встроенной документации.

Совет: Начинай с operation: "help" - возвращает детальную документацию операций с примерами. Совет: addButton автоматически создает связанную команду с именем <name> + Command.

7. Tags and Organization

get_tags — Список тегов проекта

Пользовательские метки для организации объектов. Возвращает имя, цвет, описание, количество объектов.

get_objects_by_tags — Объекты по тегам

Объекты с указанными тегами (ANY из списка). Возвращает описания тегов и FQN объектов.

8. Workspace and Tasks

list_projects — Список проектов workspace

Все проекты с именами, путями, типами и natures. Без параметров.

get_bookmarks — Закладки

Сообщение закладки, путь к файлу, номер строки.

get_tasks — Задачи (TODO/FIXME)

Задачи из кода (TODO, FIXME и т.д.) с приоритетами.

get_edt_version — Версия EDT

Возвращает версию 1C:EDT. Без параметров.

9. Application Management

get_applications — Список приложений (информационных баз)

ID приложения, имя, тип, состояние обновления. ID нужен для update_database и debug_launch.

Важно: Вызывать от основного проекта конфигурации, не от расширения. Приложения привязаны к конфигурации, расширение не имеет собственных приложений.

update_database — Обновление базы данных

Полное (full reload) или инкрементальное обновление. Требует applicationId из get_applications.

debug_launch — Запуск отладки

Запускает приложение в режиме отладки через существующую конфигурацию запуска.

10. Debugging

Группа инструментов для пошаговой отладки BSL-кода: точки останова, ожидание срабатывания, инспекция переменных, вычисление выражений, управление выполнением, запуск YAXUnit-тестов.

Типичный цикл: debug_launch (или debug_yaxunit_tests) → set_breakpoint → wait_for_break → get_variables / evaluate_expression → step / resume.

debug_status - Статус debug-сессий

Возвращает активные debug-запуски: режим (debug/run), приостановлена ли цель, количество потоков, строка верхнего frame если приостановлено.

set_breakpoint - Установка breakpoint

Устанавливает точку останова на строку BSL-модуля. Принимает EDT-относительный путь (CommonModules/Foo/Module.bsl) или абсолютный путь файла.

Совет: После установки вызывай wait_for_break чтобы блокирующе ждать срабатывания.

list_breakpoints - Список активных breakpoints

Возвращает все установленные точки останова. Опциональный фильтр по проекту.

remove_breakpoint - Удаление breakpoint

Удаляет точку останова. Можно передать либо breakpointId (возвращенный из set_breakpoint), либо координаты projectName + module + lineNumber.

wait_for_break - Ожидание срабатывания breakpoint

Блокирующе ждет suspend-событие (срабатывание breakpoint) на указанном приложении. При срабатывании возвращает снимок приостановленного потока/frame. При таймауте возвращает {hit: false} (не прерывая запуск - можно вызвать снова).

resume - Продолжить выполнение

Возобновляет приостановленный debug-поток или все потоки debug-цели. Передать threadId (из wait_for_break) или applicationId (возобновить все потоки цели).

step - Пошаговое выполнение

Шагает приостановленный debug-поток. Блокирующе ждет следующего SUSPEND-события (или таймаута), возвращает новый снимок frame.

get_variables - Переменные стек-frame

Читает переменные из stack-frame приостановленного потока. Передать frameRef из wait_for_break (предпочтительно) или threadId + frameIndex. Для раскрытия вложенных структур используй expandPath.

evaluate_expression - Вычисление BSL-выражения

Вычисляет произвольное BSL-выражение в контексте приостановленного stack-frame. ВНИМАНИЕ: выполняет произвольный BSL-код в запущенном 1С-приложении - может изменить состояние.

debug_yaxunit_tests - Запуск YAXUnit-тестов в debug режиме

Запускает YAXUnit-тесты с подключением отладчика (breakpoints срабатывают). Возвращается сразу после постановки в очередь - далее вызывай wait_for_break. Используй узкий фильтр тестов (один метод) для предсказуемости.

Требования: существующая конфигурация запуска 1С + YAXUnit установлен в информационной базе.

run_yaxunit_tests - Запуск YAXUnit-тестов без отладки

Запускает YAXUnit-тесты, polls до завершения (до timeout секунд), возвращает JUnit Markdown-отчет. Если запуск продолжается после окна polling - возвращает Pending, вызови снова для дожидания. Запуск НЕ прерывается при таймауте. Полный отчет также пишется в report.md рядом с junit.xml.

11. Profiling

Замер производительности (profiling) BSL-кода: счетчики вызовов и тайминги на каждую выполненную строку. Требует активную debug-сессию.

start_profiling - Включить замер производительности

Переключает замер производительности на активной debug-цели. После включения - запустить тестовый сценарий, затем вызвать get_profiling_results.

Требования: активная debug-сессия (debug_launch или debug_yaxunit_tests).

get_profiling_results - Результаты профилирования

Возвращает данные профилирования: по модулю, по строке - количество вызовов, время, процент. Опциональный фильтр по имени модуля и минимальной частоте вызовов.

Typical Workflows

Анализ незнакомого модуля

1. get_module_structure — получить список методов
2. read_method_source — прочитать нужные методы
3. get_method_call_hierarchy — понять, откуда вызываются

Поиск использований объекта метаданных

1. find_references — все ссылки на объект (код, формы, роли, подсистемы)
2. search_in_code — дополнительный текстовый поиск если нужно

Проверка качества после изменений

1. revalidate_objects — перевалидировать изменённые объекты
2. get_project_errors с фильтром по объектам — получить ошибки
3. get_check_description — понять суть ошибки и как исправить

Валидация запросов

1. validate_query — проверить текст запроса на синтаксис и семантику
2. validate_query с dcsMode=true — проверить запрос СКД

Обновление и тестирование

1. get_applications — получить ID приложения
2. update_database — обновить базу
3. debug_launch — запустить в отладке

Навигация к определению

1. go_to_definition с symbol — найти определение метода или объекта
2. get_symbol_info — получить тип символа в конкретной позиции
3. read_method_source — прочитать код, если нужно больше контекста

Рефакторинг метаданных

1. find_references — проверить все ссылки перед изменением
2. rename_metadata_object с preview=true — просмотр каскадных изменений
3. rename_metadata_object с confirm=true — выполнить переименование
4. revalidate_objects — проверить результат

Модификация метаданных через EDT

1. add_metadata_attribute — добавить реквизит (вместо ручного редактирования XML)
2. delete_metadata_object — удалить объект/реквизит с очисткой ссылок
3. write_module_source — записать BSL-код с автопроверкой синтаксиса

Изучение API платформы

1. get_platform_documentation с typeName — документация по типу
2. get_content_assist — автодополнение в контексте кода

Сбор контекста перед доработкой

1. ai_context с target=<FQN объекта> и depth=standard - одним вызовом получить метаданные + список модулей + структуру методов
2. При необходимости углубиться в конкретный метод - depth=full + focusMethod=<имя>

Code review изменений модуля

1. diff_module с mode=summary - обзор какие методы добавлены/изменены/удалены
2. Если нужен детальный разбор - mode=methods (отдельный diff на каждый измененный метод)
3. Для полного контекста изменений - mode=unified (git diff)

Отладка BSL-кода

1. get_applications - получить applicationId
2. debug_launch - запустить приложение в режиме отладки
3. set_breakpoint - установить breakpoint в нужном методе
4. Запустить сценарий через UI приложения или debug_yaxunit_tests
5. wait_for_break - дождаться срабатывания breakpoint
6. get_variables с frameRef - посмотреть значения переменных
7. evaluate_expression - вычислить BSL-выражение в контексте остановки
8. step (over/into/out) или resume - продолжить выполнение
9. remove_breakpoint - снять breakpoint после завершения

Профилирование BSL-кода

1. debug_launch или debug_yaxunit_tests - активная debug-сессия
2. start_profiling с applicationId - включить замер
3. Выполнить тестовый сценарий (через UI или YaxUnit)
4. get_profiling_results с moduleFilter - получить данные по вызовам/времени
5. Использовать minFrequency для фильтрации редко вызываемых строк

Модификация формы без ручного XML

1. edit_form с operation=help - получить справку по операциям
2. get_form_screenshot - визуально оценить текущее состояние формы
3. edit_form с operation=addField / addGroup / addButton / addTable / addDecoration - добавить элементы
4. edit_form с operation=removeItem - удалить ненужные элементы
5. get_form_screenshot с refresh=true - проверить результат