基本能力
产品定位
DevDocs MCP 是一个文档管理和集成的工具,旨在通过MCP协议提供高效的文档资源管理和集成能力。
核心功能
- 资源模板系统:提供URI-based的文档资源访问,支持类型安全的参数处理、灵活的URI模板匹配和全面的错误处理。
- 测试策略:使用基于属性的测试(Hypothesis)确保URI模板验证、参数提取正确性、错误处理健壮性和类型安全。
- 开发进度管理:通过分支管理跟踪功能、文档集成、任务管理和进度监控。
适用场景
- 文档管理:适用于需要结构化管理和集成文档资源的场景。
- 开发效率提升:通过类型安全的参数处理和错误处理,提升开发效率。
- 测试验证:适用于需要高健壮性和类型安全的测试场景。
工具列表
- ResourceTemplate:用于创建和管理URI模板,支持类型安全的参数处理。
- Hypothesis:用于基于属性的测试,确保系统健壮性。
- Pytest:用于运行测试套件。
常见问题解答
- 如何运行测试?
bash
pytest tests/property/test_templates.py - 如何创建资源模板?
python
from src.resources.templates.base import ResourceTemplate
template = ResourceTemplate(
uri_template='docs://api/{version}/endpoint',
parameter_types={'version': str}
)
使用教程
使用依赖
- 确保已安装Python环境。
- 安装必要的Python依赖:
bash
pip install pytest hypothesis pydantic
安装教程
- 克隆项目仓库:
bash
git clone <repository-url> - 进入项目目录:
bash
cd devdocs-mcp - 安装依赖:
bash
pip install -r requirements.txt
调试方式
- 运行测试以验证安装:
bash
pytest tests/property/test_templates.py - 检查日志和错误信息以定位问题。
- 使用开发指南中的TDD方法进行调试和开发。