Справочник инструментов MCP
MCP-сервер Nodul предоставляет инструменты, которые AI-агенты могут вызывать для управления сценариями, запуска выполнений и работы с подключениями.
Сценарии
create_scenario
Создаёт новый сценарий с заданными именем, описанием и узлами.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| name | string | да | Название сценария |
| description | string | нет | Описание сценария |
| nodes | array | да | Список узлов (см. структуру узла ниже) |
Структура узла
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
| name | string | да | Уникальное имя узла внутри сценария |
| typeAlias | string | да | Идентификатор типа узла (используйте search_node_types для поиска) |
| parameters | object | да | Параметры конфигурации узла |
| prevNodes | object | нет | Связи с предыдущими узлами и условия маршрутизации |
Выходные данные
| Поле | Тип | Описание |
|---|---|---|
| scenarioId | string | ID созданного сценария |
Примечания
- Сценарий всегда сохраняется с переданными
nameиdescriptionв виде метаданных. - MCP автоматически присваивает отображаемое имя каждому узлу сценария, даже если вы его не задали явно.
update_scenario
Заменяет существующий сценарий по ID. Все текущие узлы заменяются переданными.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| id | string | да | ID сценария для обновления |
| name | string | нет | Новое название |
| description | string | нет | Новое описание |
| nodes | array | нет | Новый список узлов (та же структура, что и в create_scenario) |
Выходные данные
| Поле | Тип | Описание |
|---|---|---|
| scenarioId | string | ID обновлённого сценария |
Примечания
- Полная замена: существующий список узлов удаляется и заменяется переданным. Для небольшого изменения используйте
patch_scenario.update_scenarioнужен только когда надо заменить сценарий целиком. - MCP автоматически присваивает отображаемые имена всем узлам, как и в
create_scenario.
patch_scenario
Применяет упорядоченный набор точечных правок. Используйте этот инструмент, когда нужно изменить часть узлов, параметров или связей, а остальной сценарий оставить как есть.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| scenarioId | string | да | Сценарий для патча |
| version | string | нет | Версия сценария. По умолчанию latest |
| operations | array | да | Операции по порядку, максимум 100. В каждом объекте ровно один ключ из таблицы ниже |
Операции (один ключ в элементе)
| Ключ | Обязательные поля | Что делает |
|---|---|---|
| updateNodeParameters | nodeName, parameters | Заменяет только перечисленные ключи параметров узла |
| replaceNode | name, typeAlias, parameters | Заменяет узел по имени (опционально prevNodes) |
| replaceNodePrevNodes | nodeName | Заменяет карту prevNodes узла (опционально prevNodes, по умолчанию {}) |
| connectNodes | nodeNameSrc, nodeNameDest | Добавляет связь в prevNodes назначения (options.condition / options.fallback) |
| addNode | name, typeAlias, parameters | Добавляет узел (опционально prevNodes) |
| removeNode | nodeName | Удаляет узел |
| renameNode | oldNodeName, newNodeName | Переименовывает узел |
Выходные данные
| Поле | Тип | Описание |
|---|---|---|
| newVersion | string | Версия, созданная этим патчем |
| removedNodeReferences | object | Ссылки, снятые вместе с удалёнными узлами |
Примечания
- Операции выполняются в порядке массива.
- Ключи
prevNodes: это имена узлов.
get_scenario
Возвращает полное описание сценария по ID.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| id | string | да | ID сценария (валидный ObjectID, например 5f92cbf10cf217478ba93561) |
| version | number | нет | Конкретная версия. По умолчанию: последняя |
Выходные данные
| Поле | Тип | Описание |
|---|---|---|
| name | string | Название сценария |
| description | string | Описание сценария |
| nodes | array | Список узлов с параметрами и связями |
activate_scenario
Активирует или деактивирует сценарий.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| id | string | да | ID сценария |
| activate | boolean | да | true для активации, false для деактивации |
Выходные данные
| Поле | Тип | Описание |
|---|---|---|
| status | string | activated или deactivated |
release_scenario
Выпускает версию сценария в production. Это шаг деплоя, а не тумблер вкл/выкл.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| scenarioId | string | да | Сценарий для релиза |
| version | string | да | Версия для выкладки (например newVersion из patch_scenario) |
Выходные данные
| Поле | Тип | Описание |
|---|---|---|
| status | string | released |
Примечания
- Это не
activate_scenario.release_scenarioвыкладывает версию;activate_scenarioвключает или выключает production-сценарий. - Для cron и production-URL вебхука нужны оба шага: релиз версии, затем
activate_scenarioсactivate: true. Успешный devrun_scenario_onceне выкладывает этот сценарий на production.
Типы узлов и подключения
search_node_types
Ищет приложения и их типы узлов. Передайте query или app: нужен один из них.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| query | string | нет | Ключевое слово. Возвращает приложения, в которых оно есть |
| app | string | нет | Название приложения. Возвращает типы действий или триггеров этого приложения. Для core-узлов (вебхук, HTTP-запрос и другие) укажите Core |
| kind | string | нет | action или trigger. Используется вместе с app |
| includeOutputSchema | boolean | нет | Если true, возвращает до 2 примеров схемы вывода для каждого типа. По умолчанию: false |
Выходные данные: массив объектов типов узлов.
| Поле | Описание |
|---|---|
| alias | Идентификатор для использования в typeAlias |
| name | Отображаемое название |
| description | Что делает узел |
| params | Настраиваемые параметры: ключ, заголовок, тип, признак обязательности, описание, значение по умолчанию и варианты выбора |
| defaultWebhookURL | Предустановленный URL вебхука, если применимо |
get_dynamic_node_parameters
Возвращает дополнительные параметры, которые становятся доступны для типа узла после установки начальных значений (например, список листов после выбора таблицы).
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| nodeTypeAlias | string | да | Идентификатор типа узла |
| currentParameters | object | да | Текущие значения параметров узла |
Выходные данные: массив дескрипторов дополнительных параметров (та же структура, что и params в search_node_types).
search_connections
Ищет сохранённые подключения текущего пользователя по псевдониму типа.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| connectionTypeAlias | string[] | да | Один или несколько псевдонимов типов подключений |
Выходные данные
| Поле | Описание |
|---|---|
| id | ID подключения для использования в параметрах узла |
| title | Отображаемое название |
| typeAlias | Тип подключения |
| lastModifiedAt | Дата последнего изменения |
create_connection
Создаёт новое подключение. Для OAuth-сервисов возвращает URL для ручного завершения авторизации.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| typeAlias | string | да | Псевдоним типа подключения |
| title | string | да | Отображаемое название подключения |
| parameters | object | нет | Параметры подключения (например, API-ключи для не-OAuth подключений) |
Выходные данные
| Поле | Описание |
|---|---|
| connectionId | ID созданного подключения |
| url | URL авторизации (возвращается, если клиент не поддерживает elicitation) |
reauthenticate_connection
Запускает повторную авторизацию существующего подключения. Если клиент не поддерживает elicitation, инструмент возвращает URL, который пользователь должен открыть и завершить авторизацию.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| connectionId | string | да | ID подключения |
Выходные данные
| Поле | Описание |
|---|---|
| url | URL, по которому пользователь завершает повторную авторизацию |
Выполнения
run_scenario_once
Запускает сценарий один раз и возвращает результат.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| scenarioId | string | да | ID сценария для запуска |
| version | string | нет | Конкретная версия. По умолчанию: последняя |
| async | boolean | нет | Если true, возвращает только executionId без ожидания. По умолчанию: false |
Выходные данные
| Поле | Описание |
|---|---|
| executionId | ID выполнения |
| result | Статус: new, waiting, success, error, in_process, cancel |
| error | Сообщение об ошибке при неудачном выполнении |
run_node_once
Запускает отдельный узел внутри сценария и возвращает его вывод. Удобно для тестирования конкретного шага без запуска всего сценария.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| scenarioId | string | да | Сценарий, содержащий узел |
| nodeName | string | да | Имя запускаемого узла |
| version | number | нет | Версия сценария. По умолчанию: последняя |
| async | boolean | нет | Если true, возвращает только executionId. По умолчанию: false |
| overrideParameters | object | нет | Значения параметров для переопределения только в этом запуске |
| compactOutput | boolean | нет | Если true, возвращает только первые 100 байт вывода. По умолчанию: true |
Выходные данные
| Поле | Описание |
|---|---|
| executionId | ID выполнения |
| result | Статус: new, waiting, success, error, in_process, cancel |
| output | Вывод узла (усечённый при compactOutput: true) |
| error | Сообщение об ошибке |
Примечания
compactOutputпо умолчаниюtrueи возвращает только первые 100 байт. Установитеfalseдля получения полного вывода.- Используйте
overrideParametersдля подстановки тестовых значений без изменения сохранённого сценария.
run_action_node_once
Запускает один узел-действие без сценария из редактора. Передайте тип узла и параметры; тул возвращает результат в том же ответе. Для пользователя: Запуск одного действия.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| nodeTypeAlias | string | да | Идентификатор типа узла (ищите через search_node_types) |
| parameters | object | нет | Параметры узла |
| session | string | нет | Сессия, если параметры ссылаются на предыдущий запуск. По умолчанию: default |
| async | boolean | нет | Если true, возвращает только executionId. По умолчанию: false |
| compactOutput | boolean | нет | Если true, каждый массив в JSON-ответе обрезается до первых 5 элементов. По умолчанию: true |
Выходные данные
Тул возвращает результат действия в том же вызове. Если узлу нужно подключение к приложению и ни одно не подходит, в ответе будет ссылка на создание авторизации.
Примечания
- Это не
run_node_once: нетscenarioId. Узел на канвасе выбирать не нужно. - Сначала пробуются существующие подключения, от более новых к старым. Если не подошли, пройдите ссылку авторизации и вызовите тул снова.
- Обязательные параметры проверяются до запуска.
- Запуск отменяется через 100 секунд.
- Служебный сценарий скрыт из списка сценариев. Успешный вызов появляется в статистике.
get_execution
Возвращает статус и выводы узлов выполнения по его ID.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| executionId | string | да | ID выполнения |
| nodeOutputsByName | string[] | нет | Имена узлов, чьи выводы включить в ответ |
Выходные данные
| Поле | Описание |
|---|---|
| status | success, error, in_process или cancel |
| error | Сообщение об ошибке |
| executedNodesCount | Карта: имя узла - количество выполнений |
| nodeOutputs | Карта: имя узла - строка вывода (для узлов из nodeOutputsByName) |
Примечания
- Используйте этот инструмент для опроса результата после вызова
run_scenario_onceилиrun_node_onceсasync: true.
get_executions_history
Возвращает историю выполнений сценария с возможностью фильтрации.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| scenarioId | string | да | ID сценария |
| limit | number | нет | Максимум выполнений в ответе. По умолчанию: 10 |
| filters.statuses | string[] | нет | Фильтр по статусу: new, waiting, success, error, in_process, cancel |
| filters.from | string | нет | Начало периода (ISO 8601) |
| filters.to | string | нет | Конец периода (ISO 8601) |
| filters.versions | string[] | нет | Фильтр по версии сценария |
| filters.environment | string | нет | dev или prod |
Выходные данные
| Поле | Описание |
|---|---|
| id | ID выполнения |
| status | Статус выполнения |
| startedAt | Время начала |
| durationInSec | Длительность в секундах |
| version | Версия сценария |
| environment | dev или prod |
MCP-сервер
Подключите AI-агентов к Nodul через MCP-сервер для создания и запуска сценариев программно.
Запуск одного действия
Запустите любое действие из каталога Nodul из ИИ-агента и получите результат в чате, без создания сценария.
Нужна помощь? Спросите сообщество
Если на странице не хватает деталей или что-то непонятно, напишите на форуме сообщества Nodul: команда и другие пользователи обычно отвечают быстро.
Программное обеспечение распространяется в виде интернет-сервиса, специальные действия по его установке на стороне пользователя не требуются.