Laravel 12 Docs MCP Server

by brianirish
Verified

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

Integrations

  • Automatically fetches and updates Laravel documentation from GitHub repository, supporting different Laravel versions and providing version control integration for documentation updates.

  • Provides access to Laravel documentation, enabling search and retrieval of Laravel docs across different versions. Includes tools for listing documentation files, searching documentation for specific terms, and automatically fetching and updating documentation from Laravel's GitHub repository.

Laravel ドキュメント MCP サーバー

AI アシスタントと言語モデルに関する Laravel ドキュメントとパッケージ推奨事項へのアクセスを提供するモデル コンテキスト プロトコル (MCP) サーバー。

概要

このサーバーにより、AIアシスタントはモデルコンテキストプロトコル(MCP)を使用してLaravelのドキュメントやパッケージの推奨事項にアクセスできるようになります。これにより、AIツールは以下のことが可能になります。

  • Laravelドキュメントにアクセスして検索する
  • 特定のユースケースに基づいてパッケージの推奨事項を受け取る
  • 人気のLaravelパッケージの実装ガイドを入手
  • Laravel の GitHub リポジトリからドキュメントを自動的に更新する

インストール

Smithery経由のクイックインストール

npx -y @smithery/cli install @brianirish/laravel-docs-mcp --client claude

手動インストール

前提条件

  • Python 3.12以上
  • uvパッケージ マネージャー (推奨)

手順

  1. リポジトリをクローンします。
    git clone https://github.com/yourusername/laravel-docs-mcp.git cd laravel-docs-mcp
  2. 環境をセットアップし、依存関係をインストールします。
    # Create and activate virtual environment uv venv source .venv/bin/activate # Linux/macOS # or .venv\Scripts\activate # Windows # Install dependencies uv pip install .

使用法

サーバーの起動

python laravel_docs_server.py

サーバーは最初の実行時に Laravel ドキュメントを自動的に取得し、Ctrl+C で停止できます。

コマンドラインオプション

オプション説明
--docs-path PATHドキュメントディレクトリのパス(デフォルト: ./docs)
--server-name NAMEサーバー名(デフォルト:LaravelDocs)
--log-level LEVELログレベル: DEBUG、INFO、WARNING、ERROR、CRITICAL (デフォルト: INFO)
--transport TYPEトランスポート方法: stdio、websocket、sse (デフォルト: stdio)
--host HOSTバインドするホスト(ネットワークトランスポート)
--port PORTリッスンするポート(ネットワークトランスポート)
--version VERSIONLaravel バージョン ブランチ (デフォルト: 12.x)
--update-docs開始前にドキュメントを更新する
--force-updateフォースドキュメントの更新

カスタム オプションの例:

python laravel_docs_server.py --docs-path /path/to/docs --version 11.x --update-docs --transport websocket --host localhost --port 8000

ドキュメントアップデータ

ドキュメントを個別に更新することもできます。

# Update documentation python docs_updater.py --target-dir ./docs --version 12.x # Check if update is needed python docs_updater.py --check-only # Force update python docs_updater.py --force

APIリファレンス

クライアントの例

import asyncio from fastmcp import Client async def main(): client = Client("path/to/laravel_docs_server.py") async with client: # List documentation result = await client.call_tool("list_docs", {}) print(result) # Search documentation result = await client.call_tool("search_docs", {"query": "routing"}) print(result) # Get package recommendations result = await client.call_tool("get_package_recommendations", {"use_case": "implementing subscription billing"}) print(result) # Read documentation resource = await client.read_resource("laravel://routing.md") print(resource) if __name__ == "__main__": asyncio.run(main())

利用可能なツール

ドキュメントツール

  • 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://{path}

例:

  • laravel://routing.md
  • laravel://authentication.md

機能とロードマップ

現在の機能:

  • ✅ Laravel の GitHub リポジトリからの動的なドキュメント更新
  • ✅ 正常なシャットダウン処理
  • ✅ コマンドラインオプションによるバージョンの柔軟性
  • ✅ ユースケースに基づいたパッケージの推奨
  • ✅ 一般的な Laravel パッケージの実装ガイド
  • ✅ Docker デプロイメントのサポート

計画されている機能:

  • マルチバージョンサポート(複数の Laravel バージョンのドキュメントに同時にアクセス)
  • カスタマイズされた推奨事項のためのユーザープロジェクト分析

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細については LICENSE ファイルを参照してください。

貢献

貢献を歓迎します!ガイドラインについてはCONTRIBUTING.mdをご覧ください。

謝辞

  • 優れたドキュメントを提供するLaravel
  • エコシステムへの貢献に対して Laravel パッケージの作者に感謝
-
security - not tested
A
license - permissive license
-
quality - not tested

AI アシスタントと言語モデルに Laravel 12 ドキュメントへのアクセスを提供し、ドキュメント ファイルの一覧表示、読み取り、検索を可能にするモデル コンテキスト プロトコル サーバー。

  1. Overview
    1. Installation
      1. Quick Install via Smithery
      2. Manual Installation
    2. Usage
      1. Starting the Server
      2. Command Line Options
      3. Documentation Updater
    3. API Reference
      1. Client Example
      2. Available Tools
      3. Resource Access
    4. Features and Roadmap
      1. License
        1. Contributing
          1. Acknowledgements
            ID: rjwaqizfuh