返回市场
代码库洞察

代码库洞察

作者:tosin201311 星标更新:2025-11-19

项目介绍

MCP 代码库洞察 - 进行中

🚧 正在开发中

该项目正处于积极开发阶段。功能和文档正在持续更新。

概述

MCP 代码库洞察是一个通过语义分析、模式检测和文档管理来分析和理解代码库的系统。

当前开发状态

已完成的功能

  • ✅ 核心向量存储系统
  • ✅ 基础知识库
  • ✅ SSE 集成
  • ✅ 测试框架
  • ✅ 测试驱动开发与调试框架(规则模板集成)

正在进行中

  • 🔄 文档管理系统
  • 🔄 高级模式检测
  • 🔄 性能优化
  • 🔄 集成测试
  • 🔄 调试工具增强

计划中

  • 📋 扩展的 API 文档
  • 📋 自定义模式插件
  • 📋 高级缓存策略
  • 📋 部署指南
  • 📋 全面的错误跟踪系统

快速开始

  1. 安装

    pip install mcp-codebase-insight
    
  2. 基本用法

    from mcp_codebase_insight import CodebaseAnalyzer
    
    analyzer = CodebaseAnalyzer()
    results = analyzer.analyze_code("path/to/code")
    
  3. 运行测试

    # 运行所有测试
    pytest tests/
    
    # 运行单元测试
    pytest tests/unit/
    
    # 运行组件测试
    pytest tests/components/
    
    # 运行带有覆盖率的测试
    pytest tests/ --cov=src --cov-report=term-missing
    
  4. 调试工具

    from mcp_codebase_insight.utils.debug_utils import debug_trace, DebugContext, get_error_tracker
    
    # 使用调试追踪装饰器
    @debug_trace
    def my_function():
        # 实现
    
    # 使用调试上下文
    with DebugContext("操作名称"):
        # 要调试的代码
    
    # 跟踪错误
    try:
        # 风险操作
    except Exception as e:
        error_id = get_error_tracker().record_error(e, context={"操作": "描述"})
        print(f"已记录错误,ID:{error_id}")
    

测试与调试

测试驱动开发

本项目遵循测试驱动开发(TDD)原则:

  1. 首先编写一个失败的测试(红)
  2. 编写最少的代码使测试通过(绿)
  3. 在保持测试通过的情况下重构以获得干净的代码(重构)

我们的 TDD 文档可以在 docs/tdd/workflow.md 中找到。

调试框架

我们使用 Agans 的 9 条调试规则:

  1. 理解系统
  2. 让它失败
  3. 不要思考,直接查看
  4. 分而治之
  5. 一次只改变一件事
  6. 保持审计轨迹
  7. 检查插头
  8. 获取新的视角
  9. 如果你没有修复它,它就没有被修复

更多关于我们的调试方法,请参阅 docs/debuggers/agans_9_rules.md

文档

贡献

我们欢迎贡献!详情请参阅我们的 贡献指南

许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。

支持