关键词

PHP开发工具代码质量静态分析单元测试自动化

项目简介

PHPocalypse MCP 是一个为 PHP 开发者设计的 Model Context Protocol (MCP) 服务器。它允许你将 PHP 项目中常用的开发工具集成到支持 MCP 协议的 LLM 客户端（如 Cursor）中，从而在 LLM 环境中直接执行代码格式化、静态分析、单元测试和行为驱动测试等任务。

主要功能点

  • 工具执行: 允许你在 YAML 配置文件中定义和注册各种 PHP 相关的命令行工具，例如代码风格检查器、静态分析器和测试运行器。
  • 命令配置: 通过简单的 YAML 格式配置文件，你可以轻松地配置每个工具的执行命令，包括命令路径、参数等。
  • 标准输出: 工具执行结果以标准 JSON 格式返回给 LLM 客户端，方便 LLM 理解和处理。
  • Stdio 传输: 使用标准的 Stdio (标准输入输出) 作为 MCP 服务器与客户端之间的通信协议，易于部署和集成。

安装步骤

  1. 克隆仓库: 首先，使用 Git 克隆 PHPocalypse-MCP 仓库到你本地的目录： 
    git clone https://github.com/plapinski/PHPocalypse-MCP
  2. 安装依赖: 进入克隆下来的仓库目录，并安装项目依赖： 
    cd PHPocalypse-MCP
npm install
  3. 创建配置文件: 在你的 PHP 项目根目录下，创建一个名为 'phpocalypse-mcp.yaml' 的配置文件。

服务器配置

在你的 MCP 客户端（例如 Cursor）的设置中，添加以下 MCP 服务器配置。请根据你的实际路径修改 'command' 和 'args' 中的路径。

{
    "mcpServers": {
        "phpocalypse-mcp": {
            "command": "npx",
            "args": ["tsx", "/Absolute/Path/To/PHPocalypse-MCP/src/index.ts", "--config", "/Absolute/Path/To/Your/PHP/Based/Project/phpocalypse-mcp.yaml"]
        }
    }
}

配置参数说明:

  • 'server name': 'phpocalypse-mcp' (服务器名称，在客户端中用于标识)
  • 'command': 'npx' (启动服务器的命令，这里使用 'npx' 运行 'tsx')
  • 'args': 启动参数，包括：
    • 'tsx': 用于执行 TypeScript 代码的工具
    • '/Absolute/Path/To/PHPocalypse-MCP/src/index.ts': PHPocalypse MCP 服务器入口文件 (请替换为 PHPocalypse-MCP 仓库在你的电脑上的绝对路径)
    • '--config': 指定配置文件路径的参数
    • '/Absolute/Path/To/Your/PHP/Based/Project/phpocalypse-mcp.yaml': 你的 PHP 项目中 'phpocalypse-mcp.yaml' 配置文件的绝对路径 (请替换为你的 PHP 项目配置文件在你的电脑上的绝对路径)

基本使用方法

  1. 确保你的 MCP 客户端已正确配置并连接到 PHPocalypse MCP 服务器。
  2. 在你的 'phpocalypse-mcp.yaml' 文件中定义你需要的 PHP 工具，例如代码格式化、静态分析或测试命令。
  3. 在 MCP 客户端中，你可以通过工具名称调用已配置的工具。服务器将执行相应的命令，并将结果返回给客户端。

例如，如果你的 'phpocalypse-mcp.yaml' 中配置了名为 'php-cs-fixer' 的工具，你可以在支持工具调用的 LLM 客户端中指示它调用 'php-cs-fixer' 工具来格式化你的 PHP 代码。

信息

分类

开发者工具

访问项目