调试mcp资源
⚠️ 原型-仅用于测试和讨论目的
______________________________________________________________________
PHP和Symfony开发的文档和参考资源。
目的
提供可通过MCP协议访问的精心策划的文档资源：
- PHP文档最佳实践、常见模式、语言特性
- Symfony文档：控制台命令、依赖注入、框架指南
特性
- 基于URI的资源访问（例如。，
php://docs/best-practices) - Markdown格式的内容针对LLM消费进行了优化
- 特定框架的指南和示例
- 通过调试mcp服务器自动发现
安装
composer require wachterjohannes/debug-mcp-resources调试mcp服务器启动时，将自动发现资源。
可用资源
PHP文档
通过以下方式访问 php://docs/{topic} URI模式。
最佳实践
URI： php://docs/best-practices
内容：PHP编码最佳实践包括：
- 类型声明和严格类型
- 错误处理模式
- 安全注意事项
- 现代PHP功能（PHP 8+）
常见模式
URI： php://docs/common-patterns
内容：常见的PHP设计模式和习惯用法：
- 依赖注入
- 工厂模式
- 存储库模式
- 服务层架构
Symfony文档
通过以下方式访问 symfony://docs/{topic} URI模式。
控制台命令
URI： symfony://docs/console-commands
内容：Symfony控制台组件指南：
- 创建自定义命令
- 命令参数和选项
- 输入输出处置
- 命令生命周期
依赖注入
URI： symfony://docs/dependency-injection
内容：Symfony DI容器指南：
- 服务配置
- 自动装配
- 服务标签
- 编译器通过
用法
通过MCP资源请求访问资源：
{
"jsonrpc": "2.0",
"method": "resources/get",
"params": {
"uri": "php://docs/best-practices"
},
"id": 1
}响应包含标记内容：
{
"jsonrpc": "2.0",
"result": {
"contents": [
{
"uri": "php://docs/best-practices",
"mimeType": "text/markdown",
"text": "# PHP Best Practices\n\n..."
}
]
},
"id": 1
}资源结构
Markdown文件
所有资源内容都存储为markdown文件 resources/:
resources/
├── php/
│ ├── best-practices.md
│ └── common-patterns.md
└── symfony/
├── console-commands.md
└── dependency-injection.md资源类
每个资源提供程序类都处理一个特定的文档域：
<?php
namespace Wachterjohannes\DebugMcp\Resources;
use Mcp\Capability\Attribute\McpResourceTemplate;
class PhpDocumentationResource
{
#[McpResourceTemplate(
uriTemplate: 'php://docs/{topic}',
name: 'php_docs',
mimeType: 'text/markdown'
)]
public function getDocumentation(string $topic): string
{
// Load and return markdown content
}
}添加新资源
要添加新资源，请执行以下操作：
- 创建Markdown文件:
放置在适当的地方 resources/ 子目录
- 更新资源类 （如果需要）：
- 扩展URI模板模式 - 添加主题验证 - 处理新文件位置
- README中的文档:
添加到具有URI模式和描述的可用资源部分
- 可选：创建新资源类:
对于新的文档域，创建新类并在composer.json中注册
注册
资源通过composer.json额外配置注册：
{
"extra": {
"wachterjohannes/debug-mcp": {
"classes": [
"Wachterjohannes\\DebugMcp\\Resources\\PhpDocumentationResource",
"Wachterjohannes\\DebugMcp\\Resources\\SymfonyDocumentationResource"
]
}
}
}发展
代码质量
提交前格式化代码：
composer cs-fix内容指南
创建资源内容时：
- 使用Markdown：清晰的标题、代码块、列表
- 提供示例：工作代码片段
- 注重实用：真实世界的用例
- 保持简洁：LLM上下文的信息密度
- 包含链接：参考官方文件
测试资源
按以下方式测试资源：
- 在调试mcp实例中安装软件包
- 正在启动MCP服务器
- 通过JSON-RPC请求资源
- 验证内容和格式
需求
- PHP 8.1或更高版本
- modelcontextprotocol/php-sdk
- wachterjohannes/debug mcp（用于测试）
仓库
github：https://github.com/wachterjohannes/debug-mcp-resources
许可证
麻省理工学院