Laravel Docs MCP

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

このサーバーは、AI ツールや言語モデルが Laravel のドキュメントやパッケージ推薦にアクセスできるようにする、Model Context Protocol (MCP) サーバーです。

🚀 クイックスタート

このサーバーを使用することで、AI ツールは Model Context Protocol (MCP) を通じて Laravel のドキュメントやパッケージ推薦にアクセスできます。具体的には以下のことが可能です。

• Laravel ドキュメントのアクセスと検索
• 特定のユースケースに対するパッケージ推薦の取得
• 人気の Laravel パッケージの実装ガイドの取得
• Laravel の GitHub リポジトリからのドキュメントの自動更新

✨ 主な機能

• AI ツールが Laravel ドキュメントにアクセスできるようにする。
• 特定のユースケースに適したパッケージを推薦する。
• 人気の Laravel パッケージの実装方法を提供する。
• ドキュメントを自動的に更新する。

📦 インストール

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. 環境を設定し、依存関係をインストールします。

   # 仮想環境を作成してアクティブ化する
   uv venv
   source .venv/bin/activate  # Linux/macOS
   # または
   .venv\Scripts\activate     # Windows
   
   # 依存関係をインストールする
   uv pip install .
   

💻 使用例

基本的な使用法

サーバーの起動

python laravel_docs_server.py

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

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

カスタムオプションを使用した例：

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

ドキュメント更新ツール

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

# ドキュメントを更新する
python docs_updater.py --target-dir ./docs --version 12.x

# 更新が必要かどうかを確認する
python docs_updater.py --check-only

# 強制的に更新する
python docs_updater.py --force

高度な使用法

クライアントサンプル

class MyClient:
    def process_document(self, content):
        # ここでドキュメント内容を処理する
        pass

if __name__ == "__main__":
    client = MyClient()
    server.start(client)

サーバークラス

import server

server = Server(host="localhost", port=8000)
server.start()

📚 ドキュメント

API リファレンス

上記の使用例で示したように、クライアントとサーバーのコード例を提供しています。具体的な API の使い方はコード内のコメントや関数名を参考にしてください。

📄 ライセンス

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

🔗 貢献

貢献は大歓迎です！貢献のガイドラインについては CONTRIBUTING.md を参照してください。