Эндпоинты

Эндпоинт — это конкретный HTTP-метод + путь, который можно вызвать (например, GET /api/users/{id}). Эндпоинты — это фактические операции API, которые LLM обнаруживает, изучает и вызывает.

Структура

Каждый эндпоинт содержит:

• HTTP-метод: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
• Путь: /api/v1/users/{id}
• Summary: краткое описание того, что делает эндпоинт — очень полезно для LLM, чтобы быстро понять его назначение
• Description: подробное объяснение поведения эндпоинта, его параметров и вариантов использования
• Параметры: path, query, header, cookie
• Тело запроса: для POST/PUT/PATCH
• Ответы: коды статуса и схемы ответов

Поля summary и description берутся из файла OpenAPI/Swagger/Postman. Это основной способ, с помощью которого LLM понимает, что делает эндпоинт. Хорошо написанные summary делают поиск эндпоинтов гораздо эффективнее.

MCP-инструменты для эндпоинтов

Инструмент	Описание
endpoint_by_spec	Все эндпоинты в спецификации
endpoint_by_collection	Эндпоинты в коллекции
endpoint_by_tag	Эндпоинты в теге
endpoint_by_id	Краткая сводка эндпоинта
inspect	Полная информация об эндпоинте (схемы, параметры)
invoke	Вызов эндпоинта
search	Поиск эндпоинтов по тексту

Устаревшие эндпоинты

Эндпоинты, помеченные как deprecated в спецификации, отображаются с предупреждением при просмотре.

Конфигурация

Эндпоинты доступны только для чтения с точки зрения swag2mcp. В YAML-конфиге нет настроек для эндпоинтов — вы не можете добавлять, удалять, переименовывать или изменять их в swag2mcp.yaml.

Чтобы изменить эндпоинты (добавить новые, обновить summary, изменить параметры, пометить как устаревшие), отредактируйте исходный файл OpenAPI/Swagger/Postman и выполните swag2mcp update для повторного разбора и индексации.

Пример

Запрос: "Покажи детали GET /pet/{petId}"
→ inspect(endpointId: "abc123...")
→ Результат:
  GET /pet/{petId}
  Summary: Найти питомца по ID
  Description: Возвращает одного питомца по его ID
  Параметры:
    - petId (path, integer, обязательно)
  Ответы:
    - 200: Объект Pet
    - 400: Ошибка
    - 404: Не найдено