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 了解指南。