Laravel ドキュメント MCP サーバー
⚠️アルファソフトウェア- このプロジェクトはまだ開発初期段階です。機能が期待どおりに動作しない可能性があり、予告なく変更が行われる可能性があります。
Laravel開発者向けのAIアシスタント。最新のLaravelドキュメントへのアクセスと、Model Context Protocol（MCP）を介したインテリジェントなパッケージレコメンデーションを提供します。これにより、AIツールは最新の情報とベストプラクティスに基づいたLaravelアプリケーションの構築を支援します。
概要
このサーバーにより、AIアシスタントはモデルコンテキストプロトコル（MCP）を使用してLaravelのドキュメントやパッケージの推奨事項にアクセスできるようになります。これにより、AIツールは以下のことが可能になります。
- Laravelドキュメントにアクセスして検索する
- 特定のユースケースに基づいてパッケージの推奨事項を受け取る
- 人気のLaravelパッケージの実装ガイドを入手
- Laravel の GitHub リポジトリからドキュメントを自動的に更新する
インストール
Smithery経由のクイックインストール
npx -y @smithery/cli install @brianirish/laravel-docs-mcp --client claude
PyPIからインストール
pip install laravel-docs-mcp
ドッカー
# Pull and run the latest version
docker run -p 8000:8000 ghcr.io/brianirish/laravel-docs-mcp:latest
# Or run a specific version
docker run -p 8000:8000 ghcr.io/brianirish/laravel-docs-mcp:v0.1.4
ソースからの手動インストール
前提条件
- Python 3.12以上
uvパッケージ マネージャー (推奨)
手順
- リポジトリをクローンします。
git clone https://github.com/brianirish/laravel-docs-mcp.git
cd laravel-docs-mcp
- 環境をセットアップし、依存関係をインストールします。
# 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 VERSION | Laravel バージョン ブランチ (デフォルト: 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://routing.mdlaravel://authentication.md
自動化されたワークフロー
このプロジェクトには、自動化された GitHub Actions ワークフローがいくつか含まれています。
毎日のドキュメント更新
- トリガー: 毎日午前0時UTC（手動でトリガーすることもできます）
- プロセス: Laravel ドキュメントの更新をチェック → PR を作成 → 自動マージ → パッチ バージョン タグを作成
- 結果: Laravelドキュメントが更新されると自動的にパッチがリリースされる
リリースパブリッシング
- トリガー: バージョンタグがプッシュされたとき (例:
v0.1.4 ) - プロセス: パッケージをビルド → PyPI に公開 → Docker イメージをビルドして GHCR にプッシュ
- 結果: PyPIとDocker Hub間でリリースが同期されました
動的バージョン管理
- バージョンソース:
hatch-vcsを使用して git タグから自動的に導出されます - 開発ビルド: 一意の識別子を取得します (例:
0.1.3.dev1+g75aec71 ) - リリースビルド: タグに一致するクリーンなバージョン番号 (例:
0.1.4 )
機能とロードマップ
現在の機能:
- ✅毎日のドキュメント更新: Laravel の GitHub リポジトリと毎日自動的に同期します
- ✅動的バージョン管理: Git タグに基づく自動バージョン管理
- ✅自動リリース: ドキュメントの更新によってトリガーされるパッチリリース
- ✅複数のデプロイメントオプション: PyPI パッケージ、Docker イメージ、Smithery マーケットプレイス
- ✅パッケージの推奨事項: 特定のユースケースに基づいたインテリジェントな提案
- ✅実装ガイダンス: 一般的な Laravel パッケージの詳細情報
- ✅柔軟な構成: 複数の Laravel バージョンとトランスポート方法をサポート
- ✅正常なシャットダウン：適切なクリーンアップとシグナル処理
計画されている機能:
- 🔄 マルチバージョンサポート（複数の Laravel バージョンのドキュメントに同時にアクセス）
- 🔍 ユーザープロジェクト分析によるカスタマイズされた推奨事項
- 🚀 セマンティックマッチングによる検索機能の強化
- 📊 使用状況分析と洞察
- 🔗 Laravelエコシステムの追加統合
ライセンス
このプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細については LICENSE ファイルを参照してください。
貢献
貢献を歓迎します！ガイドラインについてはCONTRIBUTING.mdをご覧ください。
謝辞
- 優れたドキュメントを提供するLaravel
- エコシステムへの貢献に対して Laravel パッケージの作者に感謝