К содержимому
Начало работы

Установка и первые шаги

Обновлено

Установите приложение и плагин

  1. Проверьте требования и наличие приложения MCP версии 1.3.0 или новее.
  2. Откройте карточку «Топвизор для MCP» в маркете. Войдите с Webasyst ID и установите плагин через Инсталлер в нужный аккаунт Вебасиста.
  3. Откройте приложение MCP → Плагины и выберите «Топвизор для MCP». В описании продукта этот путь сокращён до «Приложения → MCP → Плагины → Топвизор».

Подключите Топвизор

  1. В профиле Топвизора откройте раздел «API» и скопируйте User-Id и API-ключ. По описанию настроек плагина, ключ выдаётся после первого пополнения баланса.
  2. В настройках плагина заполните «User-Id Топвизора» и «API-ключ», затем сохраните настройки. User-Id должен состоять только из цифр.
  3. Повторно откройте настройки: список «Проект по умолчанию» загружается по уже сохранённым реквизитам.
  4. Выберите проект и сохраните настройки ещё раз. Проект можно не выбирать, если агент будет явно передавать project_id при чтении.

Для первой проверки оставьте «Разрешить платные проверки» выключенной. Чтение данных и получение цены доступны без неё, если выданы соответствующие права токена.

Подготовьте токен и MCP-клиент

В приложении MCP настройте токен, которым подключается ваш агент. В правах группы «Топвизор» выдайте нужные инструменты раздела «Чтение». Для первого запроса нужен topvisor_projects_list.

Подключение клиента к серверу и выдачу токена выполняет приложение MCP. API-ключ Топвизора вводится в настройки плагина; он не заменяет токен MCP, которым пользуется клиент.

Права на изменение и платные запуски выдавайте по необходимости. Их состав описан в статье «Инструменты MCP».

Проверьте результат

Попросите агента:

Покажи проекты моего аккаунта Топвизора: названия, сайты и идентификаторы.

Агент должен вызвать topvisor_projects_list. Успешный ответ содержит ok: true и список проектов. Пустой список сам по себе не означает ошибку подключения: в аккаунте может не быть подходящих проектов, а архивные проекты по умолчанию скрыты.

Затем попросите:

Для выбранного проекта покажи поисковики и регионы с region_index.
После этого покажи сводку позиций по нужному региону за доступные даты.
Новые проверки не запускай.

Нужны права на topvisor_project_searchers_regions и topvisor_positions_summary. Если съёмов ещё нет, чтение не создаст позиции. Для первого платного съёма следуйте статье «Проверки и расписание».

Если список проектов не загружается, проверьте реквизиты и исходящий HTTPS. Разбор ошибок приведён в частых вопросах.