DevDocs MCP 实现

一个用于文档管理和集成的模型上下文协议 (MCP) 实现。

项目结构

src/
├── resources/
│   ├── templates/      # 资源模板系统
│   └── managers/       # 资源管理
├── documentation/
│   ├── processors/     # 文档处理器
│   └── integrators/    # 集成处理程序
├── tasks/
│   ├── issues/         # 问题跟踪
│   └── reviews/        # 审查管理
└── tests/
    ├── property/       # 基于属性的测试
    └── integration/    # 集成测试

核心组件

资源模板系统

资源模板系统提供基于 URI 的文档资源访问，具有：

• 通过 Pydantic 实现的类型安全参数处理
• 灵活的 URI 模板匹配
• 完善的错误处理
• 资源生命周期的状态管理

使用示例：

from src.resources.templates.base import ResourceTemplate

# 创建一个带有参数类型的模板
template = ResourceTemplate(
    uri_template='docs://api/{version}/endpoint',
    parameter_types={'version': str}
)

# 提取并验证参数
params = template.extract_parameters('docs://api/v1/endpoint')
template.validate_parameters(params)

测试策略

该项目使用 Hypothesis 进行基于属性的测试，以确保：

• URI 模板验证
• 参数提取的正确性
• 错误处理的健壮性
• 类型安全强制执行

运行测试：

pytest tests/property/test_templates.py

实现进度

已完成

• [x] 基本项目结构
• [x] 资源模板系统
• [x] 基于属性的测试基础设施
• [x] URI 验证和参数提取
• [x] 错误处理基础

进行中

• [ ] 文档处理器集成
• [ ] 缓存层实现
• [ ] 任务管理系统
• [ ] 性能优化

计划中

• [ ] 搜索实现
• [ ] 分支映射系统
• [ ] 状态跟踪
• [ ] 监控系统

开发指南

1. 遵循 TDD 方法：

   • 首先编写基于属性的测试
   • 实现最小的通过代码
   • 重构以提高清晰度和效率

2. 错误处理：

   • 使用结构化的错误类型
   • 实施恢复策略
   • 维护系统稳定性

3. 文档：

   • 保持 README 更新
   • 记录新功能
   • 包括使用示例

分支管理

该项目使用基于分支的开发方法，用于：

• 功能跟踪
• 文档集成
• 任务管理
• 进度监控

贡献

1. 创建功能分支
2. 添加属性测试
3. 实现功能
4. 更新文档
5. 提交拉取请求

下一步

1. 实现文档处理器集成
2. 添加具有适当生命周期管理的缓存层
3. 开发任务管理系统
4. 创建监控和性能指标

支持资源

• MCP 概念：mcp-docs/docs/concepts/
• Python SDK：python-sdk/src/mcp/
• 示例服务器：python-sdk/examples/servers/