Документация1С-Битрикс: Модулиnative.mcpРазработчикамПримеры инструментов

Собственный инструмент

Собственный инструмент — роут пользовательской карты API-платформы с типом mcp и секцией mcp.

Роут добавляется в файл GET-роутов карты, например в local/php_interface/api/routes/GET/, а класс контроллера — в каталог контроллеров проекта, например в local/api/controllers/.

Подробнее — в статье API-платформы «Подключение карты», требования к роуту инструмента — в разделе «Инструменты».

Пример ниже — инструмент today, который возвращает текущую дату сайта.

Роут в карте

PHP

1'mcp/today' => [
2    RouteConfig::DESCRIPTION => 'Текущая дата сайта',
3    RouteConfig::ROUTE_TYPE => RouteConfig::ROUTE_TYPE_MCP,
4    ControllerConfig::CONTROLLER => [DateController::class, 'today'],
5    RouteConfig::FORMAT => TypeConfig::FORMAT_JSON,
6    RouteConfig::SECURITY => [
7        SecurityConfig::AUTH => SecurityConfig::TOKEN,
8        SecurityConfig::GROUP => [SecurityConfig::WHITELIST => ['NATIVE_MCP_CLIENT']],
9    ],
10    RouteConfig::CACHE => [CacheConfig::TTL => 0],
11    ToolConfig::ROUTE_PUBLICATION => [
12        ToolConfig::CODE => 'today',
13        ToolConfig::DESCRIPTION => 'Получить текущую дату сайта в формате YYYY-MM-DD',
14        ToolConfig::ANNOTATIONS => [ToolConfig::ANNOTATION_READ_ONLY => true],
15    ],
16],

Контроллер

PHP

1<?php
2
3namespace Local\Api;
4
5use Bitrix\Main\Type\Date;
6
7final class DateController
8{
9    public function today(): array
10    {
11        return ['date' => (new Date())->format('Y-m-d')];
12    }
13}

Дата берётся по часовому поясу сервера сайта. Кеш роута отключён, иначе агент получал бы прошлую дату. Результат вызова:

JSON

1{"date": "2026-10-25"}

Задача агенту

Текст

1Какое сегодня число на сайте?

Агент вызовет today без аргументов и ответит значением date.