关键词

AI辅助开发代码规范Prompt模板开发工作流上下文管理

项目简介

AI Guards 是一个框架，旨在标准化团队进行AI辅助代码开发的方式，涵盖计划、审查、执行和验证等阶段。它通过管理项目相关的代码规范（Rules）、Prompt模板（Templates）和开发计划（Plans），并将这些信息以结构化的方式提供给支持 Model Context Protocol (MCP) 的LLM客户端，从而确保AI输出与团队标准和项目上下文对齐，且不锁定特定的IDE或工具链。

主要功能点

  • 规则管理 (Rules): 定义并存储团队的代码风格、安全指南等规则。这些规则可以根据文件类型自动关联、始终包含，或由AI自主决定是否引入，为LLM提供重要的上下文。
  • 模板管理 (Templates): 提供可重用的Prompt模板，用于代码审查、代码生成、文档编写等常见AI任务，确保AI交互的标准化和高效。
  • 计划管理 (Plans): 帮助创建和组织AI辅助开发的计划，包括需求、指南、执行步骤等，将整个开发过程结构化。
  • MCP集成: 通过实现MCP服务器接口，将上述管理的规则、模板和计划暴露给兼容的LLM客户端，使LLM能够根据项目上下文进行更智能和相关的响应。

安装步骤

要安装AI Guards CLI工具，可以使用npm进行全局安装：

npm install -g ai-guards

安装后，在项目根目录运行初始化命令，这将创建必要的目录结构（'.ai-guards/'）并可以选择初始化Prompt模板：

npx ai-guards init

根据提示选择是否初始化模板，或使用 '--templates', '--no-templates', '--select-templates' 等选项。

服务器配置

AI Guards作为一个MCP服务器运行，需要由MCP客户端启动和连接。在支持MCP的LLM客户端（如Cursor, Claude Desktop, Windsurf等）中配置AI Guards MCP服务器时，您需要提供服务器的启动命令和参数。这些信息通常在客户端的设置界面中添加，配置项大致如下：

  • Server Name (服务器名称): 您可以自定义一个名称，例如 'ai-guards'。
  • Command (启动命令): 用于启动AI Guards MCP服务器进程的命令。对于通过npm安装的AI Guards，通常使用 'npx' 来运行包中包含的MCP服务器入口点。
    • 示例值: 'npx'
  • Args (启动参数): 传递给启动命令的参数。AI Guards包中用于启动MCP服务器的特定参数是 '-y ai-guards-mcp'。
    • 示例值: '-y ai-guards-mcp'

用户需要在其MCP客户端的配置界面中填写这些信息，客户端将使用 'npx -y ai-guards-mcp' 命令来启动AI Guards MCP服务器进程，并通过Stdio等协议与之通信。

基本使用方法

  1. 管理配置: 使用 'ai-guards' CLI命令在项目目录中管理规则 ('ai-guards rules add/sync'), 模板 ('ai-guards add/list') 和计划 ('ai-guards plan')。
  2. 连接LLM客户端: 在您的MCP兼容LLM客户端中，添加AI Guards MCP服务器配置，使用上面提供的启动命令和参数。
  3. 在LLM中调用: 配置完成后，您可以在LLM客户端的聊天界面或Prompt中提及AI Guards或其特定的规则/模板（具体调用方式取决于客户端），LLM客户端会通过MCP协议向AI Guards服务器请求相关的上下文、规则或模板内容，并将这些信息纳入模型输入，从而指导LLM的行为。

信息

分类

开发者工具

访问项目