代码治理知识库

Dev Brain是一个'治理感知'的代码知识库,用于确保AI编码助手(如GitHub Copilot、Cursor或自定义代理)遵守项目的规则和模式。

  • by UnityLoop-official
  • Python
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 Daniele-Cangi/MCP-Brain

使用说明

开发大脑

开发大脑 是您代码库的“治理意识”知识库。它充当软件架构的守护者,确保AI编码助手(如GitHub Copilot、Cursor或自定义代理)尊重项目的规则和模式。

快速入门(2分钟)

  1. 克隆并安装后端:

    git clone <repo-url>
    cd dev-brain
    pip install -r requirements.txt
    
  2. 初始化保险库: 这将扫描您的代码并创建初始知识图。

    # Set your OpenAI API Key first
    # Windows (PowerShell): $env:QDB_CODEX_API_KEY="sk-..."
    # Mac/Linux: export QDB_CODEX_API_KEY="sk-..."
    
    python -m dev_brain.codex_ingest
    
  3. 启动服务器:

    python -m dev_brain.cli_server
    

    服务器在上运行 http://127.0.0.1:8000.

  4. 安装VS代码扩展:

    • 首选 dev-brain-vscode/.
    • 跑 npm install 然后 vsce package.
    • 安装 .vsix VS代码中的文件。
    • 打开一个Python文件并运行以下命令: Dev Brain: Run Cycle for Current File.

问题与解决方案

示例

没有Dev Brain:

用户:“添加用户注册功能” 人工智能: 在服务层生成直接SQL查询 ❌ (违反了架构关注点分离)

使用Dev Brain:

用户:“添加用户注册功能” 开发大脑注射:“上下文:检测到服务层。适用规则DEC-005:不允许使用直接SQL。使用 UserRepository 图案。" 人工智能: 使用生成兼容代码 UserRepository ✅

建筑

该系统由三个主要部分组成:

  1. 保险库(.dev_brain/):基于JSON的本地知识图。
  2. 卫报:分析变化并更新合规信念。
  3. 作品集:生成具有治理意识的提示。

保险库结构(JSON)

大脑将知识储存在 .dev_brain/:

graph TD
    User([User Request]) -->|VS Code Extension| API[Dev Brain API]
    API --> Guardian
    
    subgraph "Dev Brain Core"
        Guardian -->|Analyze| Vault[(Knowledge Vault)]
        Vault -->|Context| Composer
        Guardian -->|Trigger| Composer
    end
    
    Composer -->|Governance-Aware Prompt| LLM[Coder LLM]
    LLM -->|Compliant Code| User
// decisions.json (The Rules)
[
  {
    "id": "DEC-005",
    "rule": "No direct SQL in Service Layers",
    "status": "strict",
    "amplitude": 0.9
  }
]

// rule_states/services_payment_service.json (The Beliefs)
{
  "file": "services/payment_service.py",
  "rule_states": [
    {
      "rule_id": "DEC-005",
      "state_belief": {
        "compliant": 0.0,
        "at_risk": 0.4,
        "violating": 0.6
      }
    }
  ]
}

技术细节

  • Python版本: 3.10+
  • Node.js版本:16+(用于VS代码扩展)
  • 服务器端口:8000(默认值)
  • API:使用FastAPI构建的RESTful API。
    • POST /run-cycle:触发完整的Guardian Composer管道。

路线图

  • [ ] 规则学习:从现有代码模式中自动推断规则。
  • [ ] 多回购支持:跨多个微服务共享“大脑”。
  • [ ] Git集成:根据PR审查和提交历史制定规则。
  • [ ] 插件系统:支持自定义静态分析引擎。

贡献

我们欢迎捐款!请按照以下步骤操作:

  1. 分叉存储库。
  2. 创建要素分支。
  3. 提交拉取请求。

许可证

MIT许可证。看 LICENSE 文件以获取详细信息。


常见问题解答

Q: 规则是如何定义的? A: 目前,规则是在中手动定义的 .dev_brain/decisions.json。未来的版本将支持从代码中学习规则。

Q: 它支持多种语言吗? A: 核心逻辑是语言不可知论。目前的实现侧重于Python进行解析/摘要,但可以扩展到TS/JS、Go等。

Q: 性能开销是多少? A: 最小。“大脑”异步运行。VS Code扩展等待提示生成(通常为1-2秒),但繁重的工作(更新图形)发生在后台。