Implementación de MCP de DevDocs

Una implementación del Protocolo de Contexto Modelo (MCP) para la gestión e integración de documentación.

Estructura del proyecto

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

Related MCP server: MCP Documentation Service

Componentes principales

Sistema de plantillas de recursos

El sistema de plantillas de recursos proporciona acceso basado en URI a los recursos de documentación con:

Manejo de parámetros con seguridad de tipos mediante Pydantic
Coincidencia de plantillas URI flexibles
Manejo integral de errores
Gestión de estados para el ciclo de vida de los recursos

Ejemplo de uso:

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)

Estrategia de prueba

El proyecto utiliza pruebas basadas en propiedades con Hypothesis para garantizar:

Validación de plantilla URI
Exactitud de la extracción de parámetros
Robustez en el manejo de errores
Aplicación de la seguridad de tipos

Ejecutar pruebas:

pytest tests/property/test_templates.py

Progreso de la implementación

Terminado

[x] Estructura básica del proyecto
[x] Sistema de plantillas de recursos
[x] Infraestructura de pruebas basada en propiedades
[x] Validación de URI y extracción de parámetros
[x] Fundamentos del manejo de errores

En curso

[ ] Integración del procesador de documentación
[ ] Implementación de la capa de almacenamiento en caché
[ ] Sistema de gestión de tareas
[ ] Optimización del rendimiento

Planificado

[ ] Implementación de búsqueda
[ ] Sistema de mapeo de sucursales
[ ] Seguimiento del estado
[ ] Sistema de monitoreo

Directrices de desarrollo

Siga el enfoque TDD:
- Escriba primero pruebas basadas en propiedades
- Implementar código de paso mínimo
- Refactorizar para mayor claridad y eficiencia
Manejo de errores:
- Utilice tipos de errores estructurados
- Implementar estrategias de recuperación
- Mantener la estabilidad del sistema
Documentación:
- Mantenga el README actualizado
- Documentar nuevas funciones
- Incluir ejemplos de uso

Gestión de sucursales

El proyecto utiliza un enfoque de desarrollo basado en ramas para:

Seguimiento de funciones
Integración de documentación
Gestión de tareas
Seguimiento del progreso

Contribuyendo

Crear rama de características
Agregar pruebas de propiedad
Implementar función
Actualizar la documentación
Enviar solicitud de extracción

Próximos pasos

Implementar la integración del procesador de documentación
Agregue una capa de almacenamiento en caché con una gestión adecuada del ciclo de vida
Desarrollar un sistema de gestión de tareas
Crear métricas de seguimiento y rendimiento