Laravel Docs MCP Server

Laravel Docs MCP Server

site icon
2025.04.21 0
Python文档服务包推荐开发效率
Laravel Docs MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,旨在为 AI 助手和语言模型提供 Laravel 文档访问和包推荐功能。该服务允许 AI 工具访问和搜索 Laravel 文档,根据特定用例获取包推荐,获取流行 Laravel 包的实现指导,并自动从 Laravel 的 GitHub 仓库更新文档。
View on GitHub

Overview

基本能力

产品定位

Laravel Docs MCP Server 是一个为 AI 助手和语言模型提供 Laravel 文档访问和包推荐的服务。

核心功能

  • 访问和搜索 Laravel 文档
  • 根据特定用例获取包推荐
  • 获取流行 Laravel 包的实现指导
  • 自动从 Laravel 的 GitHub 仓库更新文档

适用场景

  • AI 助手需要访问 Laravel 文档时
  • 开发者需要获取 Laravel 包推荐时
  • 需要自动更新 Laravel 文档的场景

工具列表

文档工具

  • 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) - 获取包的可用功能

常见问题解答

  • 如何更新文档?使用 python docs_updater.py --target-dir ./docs --version 12.x 命令
  • 如何检查是否需要更新文档?使用 python docs_updater.py --check-only 命令
  • 如何强制更新文档?使用 python docs_updater.py --force 命令

使用教程

使用依赖

  • Python 3.12+
  • uv 包管理器(推荐)

安装教程

快速安装

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

手动安装

  1. 克隆仓库: bash git clone https://github.com/yourusername/laravel-docs-mcp.git cd laravel-docs-mcp

  2. 设置环境并安装依赖: ```bash # 创建并激活虚拟环境 uv venv source .venv/bin/activate # Linux/macOS # 或 .venv\Scripts\activate # Windows

# 安装依赖 uv pip install . ```

调试方式

启动服务器

python laravel_docs_server.py

命令行选项

选项 描述
--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

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。