代码质量强制执行系统

AI辅助的代码质量强制执行系统,通过MCP工具、SafePatch验证和审计治理,确保AI生成代码的安全性和质量。

  • by DICKY1987
  • PowerShell
  • 本地部署
  • 更新于
在 GitHub 查看 DICKY1987/SPEC-1-AI-Upkeep-Suite-v2-Guardrails-MCP-

使用说明

人工智能辅助的代码质量管控系统

这个仓库实现了AIUOKEEP参考架构:一种确定性的(架构), 一个基于策略的护栏平台,用于协调通过(某种机制或系统)生成的AI代码变更 MCP工装、SafePatch验证及审计管理。

目录

概述

该系统使自主代理和开发者能够安全地协作 结合:

  • 模型上下文协议(MCP)服务器 暴露语言特有质量(或:体现语言特有品质) 模具工具和共享服务。
  • SafePatch验证流程 这个(工具)负责格式化、代码检查、类型检查, 测试、静态应用安全测试(SAST)、策略和密钥门禁。
  • 政策和架构护栏(或:政策和架构规范) 那些强制执行确定性变更计划的 阻止不允许的操作。
  • 审计与可观测性 具有为每个(事件/数据)捕获不可篡改记录的功能 验证运行。

建筑学

详细的组件分解、数据流以及操作方面的考虑因素包括: 提供/有售于 docs/ARCHITECTURE.md.

关键要素:

  • MCP 工具平面: 通过(某种方式)配置 /.mcp/ 脚本和 /mcp-servers/ 运行时 实现(方案/版本)。
  • 护栏: 在以下定义的JSON模式、OPA策略和Semgrep规则包 /policy/ 和 /.semgrep/。
  • SafePatch 管道: 验证协调脚本位于 scripts/validation/Invoke-SafePatchValidation.ps1 通过CI(持续集成)实现对称性/平衡性 /.github/workflows/.
  • 审计层: 账本模式在 /schemas/ledger.schema.json 以及 PowerShell 以下公用设施 /scripts/audit/。

入门指南/开始使用

  1. 安装依赖项
    • PowerShell 7.4及以上版本
    • Python 3.12+
    • Node.js(用于TypeScript工具)
  2. 克隆仓库 并审查配置文件中的内容 /.mcp/。
  3. 初始化MCP环境 通过 ./.mcp/Initialize-McpEnvironment.ps1 并且 使用(某种方法/工具)进行验证 ./.mcp/Test-McpEnvironment.ps1.
  4. 进行本地验证 和;与;带着 ./tools/Verify.ps1 在提交更改之前。
  5. 审查护栏(或:检查界限/限制) 在 docs/GUARDRAILS.md 以理解强制执行的政策。

操作工作流程

  • 开发者/代理商 作者:更改计划,应用确定性补丁,并运行 在创建拉取请求(PRs)之前,先在本地进行SafePatch处理。
  • CI/CD(持续集成/持续交付) 在(某个环境中)执行工作流 /.github/workflows/ 以反映当地检查情况,并且 发布账目条目。
  • 治理团队 显示器 /scripts/audit/Export-WeeklyReport.ps1 输出至 检测漂移或重复发生的故障。

仓库布局

  • .mcp/ — MCP服务器的期望状态配置和自动化脚本。
  • mcp-servers/ — MCP服务器实现(PowerShell、Python、SAST、密钥管理、, (政策)。
  • policy/ — JSON模式、OPA策略和Semgrep配置。
  • tools/ — 本地开发工具,包括编辑引擎实用程序和 验证协调器。
  • scripts/ — 验证、审计、沙盒和挂钩脚本。
  • docs/ — 建筑、护栏、MCP(可能是指某种系统或模块的缩写,具体需根据上下文确定,此处保留原样)集成、验证流水线、代理 指南和故障排除参考资料。
  • tests/ — 支持SafePatch强制执行的测试用例和测试套件。

文档

更多指导信息可在以下途径获取:

贡献

看见 CONTRIBUTING.md 对于分支策略和代码审查 要求,以及验证期望。所有贡献必须通过SafePatch的验证 进行验证,并包含相关的文档更新。