OWASP Cheatsheets MCP Server

owasp_cheatsheets_mcp_server

Минимально совместимый с Model Context Protocol (MCP) сервер, предоставляющий шпаргалки OWASP.

Сервер использует FastAPI для предоставления простого HTTP API, который возвращает содержимое шпаргалок из серии шпаргалок OWASP .

Предпосылки

• Python 3.8 или новее
• Git (для клонирования репозитория шпаргалки при первом запуске)

Использование

1. Требования к установке:
   pip install -r requirements.txt
2. (Необязательно) Задайте CHEATSHEETS_DIR если у вас уже есть локальная копия шпаргалок:
   export CHEATSHEETS_DIR=/path/to/CheatSheetSeries/cheatsheets
3. Запустите сервер с помощью uvicorn :
   uvicorn server.app:app --reload
4. Если CHEATSHEETS_DIR не задан, сервер клонирует репозиторий шпаргалок при первом запуске (требуется доступ к сети).

Конечные точки

• GET /health – Базовая проверка работоспособности.
• GET /cheatsheets – Вывести список доступных файлов шпаргалок.
• GET /cheatsheets/{name} – Получить конкретную шпаргалку.
• GET /search?q=term – Поиск термина в шпаргалках и возврат соответствующих имен файлов.

Запуск в производство

Используйте uvicorn с явным указанием хоста и порта при развертывании:

Для реального развертывания рассмотрите возможность использования менеджера процессов, например systemd , или запуска через обратный прокси-сервер.

Внося вклад

Запросы на извлечение приветствуются. Тесты можно добавлять в каталог tests/ с помощью pytest .

Данная реализация представляет собой упрощенный пример сервера MCP и может не охватывать всю спецификацию.