文档管理集成协议

一个用于文档管理和集成的模型上下文协议(MCP)实现,提供资源模板系统、测试策略和开发指南。

  • by llmian-space
  • Python
  • 本地部署
  • 9 星标
  • 更新于
在 GitHub 查看 llmian-space/devdocs-mcp

使用说明

DevDocs MCP实现

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

项目结构

src/
├── resources/
│   ├── templates/      # Resource template system
│   └── managers/       # Resource management
├── documentation/
│   ├── processors/     # Documentation processing
│   └── integrators/    # Integration handlers
├── tasks/
│   ├── issues/         # Issue tracking
│   └── reviews/        # Review management
└── tests/
    ├── property/       # Property-based tests
    └── integration/    # Integration tests

核心组件

资源模板系统

资源模板系统通过以下方式提供对文档资源的基于URI的访问:

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

示例用法:

from src.resources.templates.base import ResourceTemplate

# Create a template with parameter typing
template = ResourceTemplate(
    uri_template='docs://api/{version}/endpoint',
    parameter_types={'version': str}
)

# Extract and validate parameters
params = template.extract_parameters('docs://api/v1/endpoint')
template.validate_parameters(params)

测试策略

该项目使用基于属性的测试和假设来确保:

  • 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/