Laravel Docs MCP

🚀 Laravel 文檔 MCP 服務器

這是一個 Model Context Protocol (MCP) 服務器，可供 AI 助手和語言模型訪問 Laravel 文檔和獲取包推薦，為 AI 工具與 Laravel 相關資源的交互提供了便利。

🚀 快速開始

此服務器支持 AI 工具通過 Model Context Protocol (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. 設置環境並安裝依賴項：

   # 創建並激活虛擬環境
   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()

📄 許可證

此項目使用 MIT 許可證，有關詳細信息，請參閱 LICENSE 文件。

🌟 貢獻

歡迎貢獻！請查閱 CONTRIBUTING.md 瞭解指南。