TUI-обозреватель

Обзор

swag2mcp включает встроенный TUI (Terminal User Interface) для интерактивного исследования API. Это полноэкранное терминальное приложение, позволяющее искать, просматривать, проверять и вызывать API-эндпоинты без выхода из терминала.

Запуск

swag2mcp run

Если конфигурационный файл не существует, TUI автоматически запустит мастер инициализации.

Режимы

TUI имеет три режима, переключаемых клавишей Tab:

Режим поиска

Полнотекстовый поиск по всем эндпоинтам во всех спецификациях. Поддерживает тот же синтаксис запросов, что и MCP-инструмент search.

• Введите запрос для поиска по именам эндпоинтов, путям и описаниям
• Фильтруйте результаты по методу, тегу или пути
• Просматривайте детали эндпоинта одним нажатием клавиши
• Навигируйте по результатам с пагинацией (10 элементов на страницу)

Режим просмотра

Древовидная навигация по иерархии спецификаций:

Спецификация → Коллекция → Тег → Эндпоинт

• Спускайтесь по дереву для поиска конкретных эндпоинтов
• Просматривайте детали эндпоинта (параметры, тело запроса, ответы)
• Вызывайте API напрямую из TUI
• Сохраняйте детали эндпоинта в JSON-файл

Режим аутентификации

Просмотр токенов аутентификации и заголовков для любой спецификации. Полезно для отладки или генерации curl-команд.

Управление

Клавиша	Действие
↑ / ↓	Навигация вверх/вниз
Enter	Выбрать или открыть
Esc	На один уровень назад
Tab	Переключение между режимами поиска, просмотра и аутентификации
/	Фокус на поле поиска
N / P	Следующая / предыдущая страница
B	Назад к предыдущему экрану
M	Возврат в главное меню
S	Сохранить детали эндпоинта в JSON-файл
q / Ctrl+C	Выход

Состояния

TUI проходит через следующие состояния по мере навигации:

1. Загрузка — загрузка данных из рабочей области
2. Поиск — режим поиска с полем ввода запроса
3. Просмотр — режим просмотра со списком спецификаций
4. Список спецификаций — список всех спецификаций
5. Список коллекций — коллекции в спецификации
6. Список тегов — теги в коллекции
7. Список эндпоинтов — эндпоинты в теге
8. Детали эндпоинта — полная информация об эндпоинте
9. Результат вызова — результат API-вызова
10. Ошибка — состояние ошибки с сообщением

Просмотр деталей эндпоинта

При выборе эндпоинта TUI показывает:

• HTTP-метод и путь
• Базовый URL и полный URL
• Описание и сводку
• Все параметры (имя, расположение, тип, обязательность)
• Схему тела запроса (если применимо)
• Коды ответов и схемы
• Статус устаревания

Требования

• Размер терминала: Не менее 80×24 символов
• Эмулятор терминала: Работает в большинстве современных терминалов (iTerm2, Terminal.app, GNOME Terminal, Windows Terminal и т.д.)
• SSH: Работает через SSH-соединения

Важные замечания

• Автоинициализация — если конфигурационный файл не существует, TUI автоматически запускает мастер инициализации
• Пагинация — списки разбиты на страницы по 10 элементов. Используйте N и P для навигации
• Сохранение деталей эндпоинта — нажмите S в режиме просмотра деталей эндпоинта, чтобы сохранить полную информацию в JSON-файл в текущей директории
• Режим аутентификации — показывает токены и заголовки для отладки. В продакшене инструмент аутентификации может быть отключён с помощью --disable-llm-auth