🚧 Desarrollo en progreso
Este proyecto está en desarrollo activo. Las funciones y la documentación se actualizan constantemente.
Descripción general
MCP Codebase Insight es un sistema para analizar y comprender bases de código a través del análisis semántico, la detección de patrones y la gestión de documentación.
Estado actual del desarrollo
Funciones completadas
- ✅ Sistema de almacenamiento vectorial básico
- ✅ Base de conocimientos básicos
- ✅ Integración SSE
- ✅ Marco de pruebas
- ✅ TDD y marco de depuración (integración con rules_template)
En curso
- 🔄 Sistema de Gestión de Documentación
- 🔄 Detección avanzada de patrones
- 🔄 Optimización del rendimiento
- Pruebas de integración
- 🔄 Mejora de las utilidades de depuración
Planificado
- Documentación API extendida
- 📋 Complementos de patrones personalizados
- Estrategias avanzadas de almacenamiento en caché
- Guías de implementación
- 📋 Sistema integral de seguimiento de errores
Inicio rápido
- Instalación
pip install mcp-codebase-insight
- Uso básico
from mcp_codebase_insight import CodebaseAnalyzer
analyzer = CodebaseAnalyzer()
results = analyzer.analyze_code("path/to/code")
- Ejecución de pruebas
# Run all tests
pytest tests/
# Run unit tests
pytest tests/unit/
# Run component tests
pytest tests/components/
# Run tests with coverage
pytest tests/ --cov=src --cov-report=term-missing
- Utilidades de depuración
from mcp_codebase_insight.utils.debug_utils import debug_trace, DebugContext, get_error_tracker
# Use debug trace decorator
@debug_trace
def my_function():
# Implementation
# Use debug context
with DebugContext("operation_name"):
# Code to debug
# Track errors
try:
# Risky operation
except Exception as e:
error_id = get_error_tracker().record_error(e, context={"operation": "description"})
print(f"Error recorded with ID: {error_id}")
Pruebas y depuración
Desarrollo basado en pruebas
Este proyecto sigue los principios de desarrollo impulsado por pruebas (TDD):
- Escribe primero una prueba fallida (Rojo)
- Escriba el código mínimo para que la prueba pase (Verde)
- Refactorizar para obtener un código limpio y mantener la aprobación de las pruebas (Refactor)
Nuestra documentación TDD se puede encontrar en docs/tdd/workflow.md .
Marco de depuración
Utilizamos las 9 reglas de depuración de Agans:
- Entender el sistema
- Haz que fracase
- Deja de pensar y mira
- Divide y vencerás
- Cambia una cosa a la vez
- Mantener un registro de auditoría
- Compruebe el enchufe
- Obtenga una nueva perspectiva
- Si no lo arreglaste, no está arreglado
Obtenga más información sobre nuestro enfoque de depuración en docs/debuggers/agans_9_rules.md .
Documentación
Contribuyendo
¡Agradecemos sus contribuciones! Consulte nuestra Guía de Contribución para más detalles.
Licencia
Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.
Apoyo