Document OpenAPI import workflow
This commit is contained in:
+28
-1
@@ -19,6 +19,34 @@
|
||||
|
||||
Черновик можно редактировать и тестировать. MCP-клиенты видят только опубликованные операции, которые привязаны к опубликованному агенту.
|
||||
|
||||
### Создание операции
|
||||
|
||||
В мастере операции основной сценарий такой:
|
||||
|
||||
1. Выбрать REST.
|
||||
2. Выбрать upstream или добавить новый `Base URL`.
|
||||
3. Указать HTTP-метод и путь endpoint-а.
|
||||
4. Описать инструмент и его входную/выходную схему.
|
||||
5. Загрузить или вставить JSON-пример запроса и ответа.
|
||||
6. Связать поля инструмента с `Path`, `Query`, `Header` и `Body`.
|
||||
7. Выбрать поля ответа API, которые вернет MCP-инструмент.
|
||||
8. Запустить тест.
|
||||
9. Сохранить и опубликовать операцию.
|
||||
|
||||
Для обычной работы достаточно визуального конструктора связей. YAML/JSONPath открыт в блоке **Дополнительно** для сложных случаев: вложенные поля, ручная правка, перенос готовой конфигурации.
|
||||
|
||||
Если пример ответа содержит массив, визуальное дерево показывает поля первого элемента как `items[0].name`. Это удобно, когда агенту нужно одно конкретное поле. Если агенту нужен весь список, используйте блок **Дополнительно** и верните массив целиком.
|
||||
|
||||
### Импорт OpenAPI
|
||||
|
||||
Кнопка **Импорт OpenAPI** создает черновики операций из OpenAPI/Swagger. После импорта откройте черновик в мастере и проверьте:
|
||||
|
||||
- описание инструмента;
|
||||
- входные поля;
|
||||
- связи `Path / Query / Header / Body`;
|
||||
- пример тестового запроса;
|
||||
- поля ответа, которые попадут в результат инструмента.
|
||||
|
||||
## Агенты
|
||||
|
||||
Агент - это отдельный MCP endpoint с выбранным набором инструментов.
|
||||
@@ -51,4 +79,3 @@ API-ключ выдается на конкретного агента. Ключ
|
||||
Раздел **Логи** показывает вызовы операций, ошибки маппинга, ошибки REST API и успешные ответы.
|
||||
|
||||
Раздел **Использование** показывает количество вызовов, ошибки и задержки по операциям.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user