DevDocs MCP

by llmian-space

Integrations

  • Used for property-based testing to ensure URI template validation, parameter extraction correctness, error handling robustness, and type safety enforcement

  • Provides type-safe parameter handling for the resource template system, enabling validation and extraction of parameters from URIs

  • Supports the testing infrastructure, allowing for property-based and integration tests to validate the functionality of the documentation management system

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/
-
security - not tested
A
license - permissive license
-
quality - not tested

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

模型上下文协议实现,支持 AI 访问文档资源,具有基于 URI 的导航、模板匹配和结构化文档管理等特点。

  1. Project Structure
    1. Core Components
      1. Resource Template System
      2. Testing Strategy
    2. Implementation Progress
      1. Completed
      2. In Progress
      3. Planned
    3. Development Guidelines
      1. Branch Management
        1. Contributing
          1. Next Steps
            1. Support Resources

              Related MCP Servers

              • -
                security
                F
                license
                -
                quality
                A Model Context Protocol server utilizing Claude AI for generating intelligent queries and offering documentation assistance based on API documentation analysis.
                Last updated -
                3
                2
                TypeScript
              • A
                security
                A
                license
                A
                quality
                A Model Context Protocol implementation that enables AI assistants to interact with markdown documentation files, providing capabilities for document management, metadata handling, search, and documentation health analysis.
                Last updated -
                14
                346
                11
                TypeScript
                MIT License
                • Apple
                • Linux
              • A
                security
                A
                license
                A
                quality
                A Model Context Protocol server that enables AI assistants like Claude to interact with Outline document services, supporting document searching, reading, creation, editing, and comment management.
                Last updated -
                25
                1
                Python
                MIT License
              • A
                security
                A
                license
                A
                quality
                A Model Context Protocol server that enables AI assistants to interact with Confluence content, supporting operations like retrieving, searching, creating, and updating pages and spaces.
                Last updated -
                9
                3
                TypeScript
                MIT License

              View all related MCP servers

              ID: 3ccn0tqnhm