Laravel Docs MCP-сервер
⚠️ Alpha Software — этот проект находится на ранней стадии разработки. Функции могут работать не так, как ожидалось, а критические изменения могут происходить без уведомления.
Помощник ИИ для разработчиков Laravel, который обеспечивает доступ к последней документации Laravel и рекомендациям по интеллектуальным пакетам через Model Context Protocol (MCP). Это позволяет инструментам ИИ помогать вам создавать приложения Laravel с актуальной информацией и лучшими практиками.
Обзор
Этот сервер позволяет помощникам ИИ получать доступ к документации Laravel и рекомендациям по пакетам с использованием Model Context Protocol (MCP). Он позволяет инструментам ИИ:
- Доступ и поиск в документации Laravel
- Получайте рекомендации по пакетам на основе конкретных вариантов использования
- Получите руководство по внедрению популярных пакетов Laravel
- Автоматически обновлять документацию из репозитория Laravel GitHub
Установка
Быстрая установка через Smithery
Установить из PyPI
Докер
Ручная установка из источника
Предпосылки
- Питон 3.12+
- менеджер пакетов
uv
(рекомендуется)
Шаги
- Клонируйте репозиторий:
- Настройте среду и установите зависимости:
Использование
Запуск сервера
Сервер автоматически загружает документацию Laravel при первом запуске и может быть остановлен с помощью Ctrl+C.
Параметры командной строки
Вариант | Описание |
---|---|
--docs-path PATH | Путь к каталогу документации (по умолчанию: ./docs) |
--server-name NAME | Имя сервера (по умолчанию: LaravelDocs) |
--log-level LEVEL | Уровень журнала: ОТЛАДКА, ИНФОРМАЦИЯ, ПРЕДУПРЕЖДЕНИЕ, ОШИБКА, КРИТИЧЕСКИЙ (по умолчанию: ИНФОРМАЦИЯ) |
--transport TYPE | Метод транспортировки: stdio, websocket, sse (по умолчанию: stdio) |
--host HOST | Хост для привязки (сетевой транспорт) |
--port PORT | Порт для прослушивания (сетевой транспорт) |
--version VERSION | Ветка версии Laravel (по умолчанию: 12.x) |
--update-docs | Обновите документацию перед началом |
--force-update | Принудительное обновление документации |
Пример с пользовательскими параметрами:
Обновление документации
Вы можете обновить документацию отдельно:
Ссылка на API
Пример клиента
Доступные инструменты
Инструменты документирования
list_docs()
— список всех файлов документацииsearch_docs(query: str)
— Поиск документации по определенным терминамupdate_docs(version: Optional[str], force: bool)
— Обновление документацииdocs_info()
— Получить информацию о версии документации
Инструменты рекомендации пакетов
get_package_recommendations(use_case: str)
— Получить рекомендации по пакетам для варианта использованияget_package_info(package_name: str)
— Получить сведения о конкретном пакетеget_package_categories(category: str)
— список пакетов в определенной категорииget_features_for_package(package: str)
— Получить доступные функции для пакета
Доступ к ресурсам
Доступ к файлам документации как к ресурсам можно получить с помощью:
Примеры:
laravel://routing.md
laravel://authentication.md
Автоматизированные рабочие процессы
Этот проект включает в себя несколько автоматизированных рабочих процессов GitHub Actions:
Ежедневные обновления документации
- Триггер : каждый день в полночь по всемирному координированному времени (также можно запустить вручную)
- Процесс : Проверка обновлений документации Laravel → Создание PR → Автоматическое слияние → Создание тега версии патча
- Результат : автоматический выпуск патчей при обновлении документации Laravel.
Выпуск публикации
- Триггер : при отправке тегов версии (например,
v0.1.4
) - Процесс : Сборка пакетов → Публикация в PyPI → Сборка и отправка образов Docker в GHCR
- Результат : синхронизированные релизы через PyPI и Docker Hub.
Динамическое управление версиями
- Источник версии : Автоматически получен из тегов git с помощью
hatch-vcs
- Сборки для разработки : получите уникальные идентификаторы (например,
0.1.3.dev1+g75aec71
) - Сборки релизов : чистые номера версий, соответствующие тегам (например,
0.1.4
)
Особенности и дорожная карта
Текущие возможности:
- ✅ Ежедневные обновления документации : автоматическая синхронизация с репозиторием Laravel GitHub каждый день
- ✅ Динамическое управление версиями : автоматическое управление версиями на основе тегов git
- ✅ Автоматизированные выпуски : выпуски исправлений, вызванные обновлениями документации
- ✅ Несколько вариантов развертывания : пакет PyPI, образы Docker и торговая площадка Smithery
- ✅ Рекомендации по пакетам : интеллектуальные предложения, основанные на конкретных вариантах использования
- ✅ Руководство по внедрению : подробная информация по распространенным пакетам Laravel
- ✅ Гибкая конфигурация : поддержка нескольких версий Laravel и методов транспортировки
- ✅ Мягкое выключение : правильная очистка и обработка сигналов
Планируемые функции:
- 🔄 Поддержка нескольких версий (доступ к документации для нескольких версий Laravel одновременно)
- 🔍 Анализ пользовательских проектов для индивидуальных рекомендаций
- 🚀 Расширенные возможности поиска с семантическим соответствием
- 📊 Аналитика использования и идеи
- 🔗 Дополнительные интеграции экосистемы Laravel
Лицензия
Данный проект лицензирован по лицензии MIT — подробности см. в файле LICENSE.
Внося вклад
Вклады приветствуются! Смотрите CONTRIBUTING.md для инструкций.
Благодарности
- Laravel за их прекрасную документацию
- Авторам пакетов Laravel за их вклад в экосистему
This server cannot be installed
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Сервер Model Context Protocol, который предоставляет помощникам ИИ и языковым моделям доступ к документации Laravel 12, позволяя им просматривать, читать и искать файлы документации.
Related MCP Servers
- -securityFlicense-qualityA Model Context Protocol server utilizing Claude AI for generating intelligent queries and offering documentation assistance based on API documentation analysis.Last updated -32TypeScript
- AsecurityAlicenseAqualityA Model Context Protocol server that enables AI assistants like Claude to interact with Outline document services, supporting document searching, reading, creation, editing, and comment management.Last updated -2519PythonMIT License
- AsecurityFlicenseAqualityA Model Context Protocol server that enables AI assistants like Claude to access and search Atlassian Confluence content, allowing integration with your organization's knowledge base.Last updated -53198TypeScript
- AsecurityAlicenseAqualityA Model Context Protocol server that enables AI assistants to interact with Confluence content, supporting operations like retrieving, searching, creating, and updating pages and spaces.Last updated -93TypeScriptMIT License