Справочник инструментов MCP
MCP Server Nodul предоставляет 12 инструментов, которые 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 обновлённого сценария |
Примечания
- Полная замена: существующий список узлов удаляется и заменяется переданным. Для частичных изменений сначала вызовите
get_scenario, измените результат, затем вызовитеupdate_scenario. - MCP автоматически присваивает отображаемые имена всем узлам, как и в
create_scenario.
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 |
Типы узлов и подключения
search_node_types
Ищет доступные типы узлов по ключевым словам. Возвращает до 20 результатов на одно слово.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| query | string[] | да | Одно ключевое слово на элемент. Результаты должны совпадать со всеми словами |
| 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
Ищет сохранённые подключения текущего пользователя по псевдониму типа.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| alias | string[] | да | Один или несколько псевдонимов типов подключений |
Выходные данные
| Поле | Описание |
|---|---|
| id | ID подключения для использования в параметрах узла |
| title | Отображаемое название |
| typeAlias | Тип подключения |
| lastModifiedAt | Дата последнего изменения |
create_connection
Создаёт новое подключение. Для OAuth-сервисов возвращает URL для ручного завершения авторизации.
Входные параметры
| Параметр | Тип | Обязательно | Описание |
|---|---|---|---|
| typeAlias | string | да | Псевдоним типа подключения |
| title | string | да | Отображаемое название подключения |
| parameters | object | нет | Параметры подключения (например, API-ключи для не-OAuth подключений) |
Выходные данные
| Поле | Описание |
|---|---|
| connectionId | ID созданного подключения |
| url | URL авторизации (возвращается, если клиент не поддерживает elicitation) |
Выполнения
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 | да | Имя запускаемого узла |
| nodes | array | да | Полный список узлов (та же структура, что и в create_scenario) |
| 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для подстановки тестовых значений без изменения сохранённого сценария.
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 Server
Подключите AI-агентов к Nodul через MCP Server для создания и запуска сценариев программно.
Основы работы с базой данных
Встроенная база: структурированные данные в хранилищах и коллекциях; основы работы с базой и узлами сценария.
Нужна помощь? Спросите сообщество
Если на странице не хватает деталей или что-то непонятно, напишите на форуме сообщества Nodul: команда и другие пользователи обычно отвечают быстро.
Программное обеспечение распространяется в виде интернет-сервиса, специальные действия по его установке на стороне пользователя не требуются.