使用说明

项目简介

μMCP-php 是一个使用PHP开发的极简Model Context Protocol (MCP) 服务器库。它旨在帮助开发者快速搭建轻量级的MCP服务器,以便为大型语言模型 (LLM) 应用提供工具调用功能。该库实现了MCP协议中关于工具 (Tools) 的核心部分,并通过HTTP协议与客户端通信。由于其轻量化设计,μMCP-php 不包含会话管理、参数校验、服务器推送事件等高级特性,但对于许多基本的工具集成场景已足够使用。 请注意,μMCP-php 依赖于 MCP2HTTP 或类似的适配器才能与MCP客户端协同工作。

主要功能点

  • 超轻量级: 代码简洁,无外部依赖,易于集成和部署。
  • HTTP 传输: 基于HTTP协议的请求响应模式,易于理解和实现。
  • 工具支持: 允许注册和执行外部工具,扩展LLM的功能。
  • 简单API: 提供简单的PHP函数接口,易于配置和使用。

安装步骤

  1. 下载 umcp.php: 从 GitHub 仓库 umcp-php 下载 'umcp.php' 文件。
  2. 引入到项目: 将 'umcp.php' 文件复制到你的PHP项目目录中,并在你的服务器代码中引入它:
    <?php
    $umcp = require 'path/to/umcp.php';

服务器配置

由于 μMCP-php 自身是一个库,你需要一个PHP运行环境来运行它。为了让MCP客户端能够访问 μMCP-php 服务器,你需要配置一个 MCP2HTTP 适配器 作为桥梁。 MCP2HTTP 将 MCP 协议转换为 HTTP 协议,使得客户端可以通过 HTTP 与 μMCP-php 服务器通信。

以下是 MCP 客户端配置 'MCP2HTTP' 的示例 (JSON 格式):

{
  "mcpServers": {
    "my-umcp-server": {  // MCP 服务器名称,可以自定义
      "command": "npx",   // 启动命令,这里使用 npx
      "args": [          // 命令参数
        "-y",             // 自动确认安装
        "mcp2http",       // 运行 MCP2HTTP 适配器
        "http://localhost:8000/your-umcp-server.php" // μMCP-php 服务器的 HTTP 地址,根据你的实际部署修改
      ]
    }
  }
}

参数注释:

  • 'server name': MCP 服务器的名称,在客户端中用于标识和引用该服务器,可以自定义。例如 '"my-umcp-server"'。
  • 'command': 启动 MCP2HTTP 适配器的命令,通常是 'npx' (如果你的环境中安装了 Node.js 和 npm)。
  • 'args': 传递给 'npx' 命令的参数列表。
    • '"-y"': 可选参数,用于在使用 'npx' 安装 'mcp2http' 时自动确认安装。
    • '"mcp2http"': 指定要运行的 npm 包为 'mcp2http'。
    • '"http://localhost:8000/your-umcp-server.php"': μMCP-php 服务器的 HTTP 地址。你需要将 'your-umcp-server.php' 替换为你的实际PHP服务器脚本文件名,'localhost:8000' 替换为你的PHP服务器的地址和端口。确保这个地址是 MCP2HTTP 适配器可以访问的。

重要提示: 你需要先启动一个PHP服务器来运行你的 μMCP-php 脚本 (例如使用 PHP 内置的开发服务器 'php -S localhost:8000 your-umcp-server.php'),然后再配置 MCP 客户端连接到通过 MCP2HTTP 适配器暴露的地址。

基本使用方法

  1. 创建服务器脚本: 创建一个 PHP 文件 (例如 'my-umcp-server.php'),并引入 'umcp.php'。
  2. 定义服务器信息: 设置服务器的名称和版本。
  3. 定义工具: 创建工具数组,每个工具包含 'description' (描述), 'parameters' (参数定义), 和 'handler' (处理函数)。
  4. 启动服务器: 调用 'umcp()' 函数,传入服务器信息和工具定义。

示例代码 (my-umcp-server.php):

<?php
$umcp = require 'umcp.php';

$umcp(
    ['name' => 'umcp-calculator', 'version' => '1.0.0'],
    [
        'add' => [
            'description' => 'Add two numbers together',
            'parameters' => [
                'type' => 'object',
                'properties' => [
                    'a' => ['type' => 'number'],
                    'b' => ['type' => 'number']
                ],
                'required' => ['a', 'b']
            ],
            'handler' => function($args) {
                return $args['a'] + $args['b'];
            }
        ]
    ]
);
  1. 运行 PHP 服务器: 使用 PHP 内置服务器或其他 Web 服务器运行你的脚本,例如: 'php -S localhost:8000 my-umcp-server.php'。
  2. 配置 MCP 客户端: 按照服务器配置章节的说明,配置你的 MCP 客户端,使其通过 MCP2HTTP 适配器连接到你的 μMCP-php 服务器。

现在,你的 MCP 客户端应该能够发现并调用你定义的工具了。

信息

分类

开发者工具