MCP Php Starter

MCP PHP入门

   

PHP中一个功能完整的模型上下文协议（MCP）服务器模板。此入门程序使用干净的生产就绪代码演示了MCP的所有主要功能。

📚 文档

• 模型上下文协议
• PHP-SDK
• 构建MCP服务器

✨ 特性

🚀 快速开始

先决条件

• PHP 8.2+
• 作曲家

安装

# Clone the repository
git clone https://github.com/SamMorrowDrums/mcp-php-starter.git
cd mcp-php-starter

# Install dependencies
composer install

运行服务器

stdio传输 （地方发展）：

composer start:stdio
# or
php bin/server-stdio.php

HTTP传输 （用于远程/web部署）：

composer start:http
# Server runs on http://localhost:3000

🔧 VS代码集成

该项目包括用于无缝开发的VS代码配置：

1. 在VS Code中打开项目
2. MCP配置位于 .vscode/mcp.json
3. 使用VS Code的MCP工具测试服务器

📁 项目结构

.
├── bin/
│   ├── server-stdio.php   # stdio transport entrypoint
│   └── server-http.php    # HTTP transport entrypoint
├── public/
│   └── index.php          # HTTP web entrypoint
├── src/
│   └── McpElements.php    # Tools, resources, and prompts
├── tests/
│   └── ...
├── .vscode/
│   └── mcp.json           # MCP server configuration
├── composer.json
├── server.json            # MCP discovery configuration
└── README.md

🛠️ 发展

# Install dependencies
composer install

# Run code style check
composer cs-check

# Fix code style
composer cs-fix

# Run tests
composer test

🔍 MCP 检查员

这 MCP 检查员 是测试和调试MCP服务器的重要开发工具。

运行检查器

npx @modelcontextprotocol/inspector php bin/server-stdio.php

检查员提供什么

• 工具选项卡：列出并调用所有已注册的带有参数的工具
• 资源选项卡：浏览和阅读资源
• 提示选项卡：查看和测试提示模板
• 日志选项卡：请参阅客户端和服务器之间的JSON-RPC消息

📖 功能示例

具有自定义模式的工具

所有工具都是使用自定义输入模式手动注册的，这些模式包括 title 和 description 跨语言一致性字段：

// In ServerFactory.php
->addTool(
    handler: [$elements, 'hello'],
    name: 'hello',
    description: 'Say hello to a person',
    inputSchema: [
        'type' => 'object',
        'properties' => [
            'name' => [
                'type' => 'string',
                'title' => 'Name',
                'description' => 'Name of the person to greet',
            ],
        ],
        'required' => ['name'],
    ]
)

资源

->addResource(
    handler: [$elements, 'getAbout'],
    uri: 'about://server',
    name: 'About',
    description: 'Information about this MCP server',
    mimeType: 'text/plain'
)

资源模板

->addResourceTemplate(
    handler: [$elements, 'getPersonalizedGreeting'],
    uriTemplate: 'greeting://{name}',
    name: 'Personalized Greeting',
    description: 'A personalized greeting for a specific person',
    mimeType: 'text/plain'
)

提示

->addPrompt(
    handler: [$elements, 'greetPrompt'],
    name: 'greet',
    description: 'Generate a greeting message'
)

🔐 环境变量

🤝 贡献

欢迎投稿！请确保您的更改与其他语言初学者保持功能对等。

📄 许可证

MIT许可证-请参阅 许可证 了解详情。