mcpField
C
caira

caira

github.com/microsoft开发22948 次安装17 周前更新
代码仓库

关于 caira

CAIRA 是为生成式 AI 解决方案开发者提供的参考组件库,而非应用生成器。它引导开发者检查代码库、选择并适配所需架构组件,并优先采用小范围复用及无密码身份模式。

主要功能

  1. 01按需选择参考架构组件
  2. 02检查完整组件源代码
  3. 03适配现有技术栈与代码库
  4. 04采用托管身份等无密码模式
  5. 05验证 IaC、应用与容器构建

适用场景

  1. 01为生成式 AI 项目选择基础设施组件
  2. 02基于参考代码扩展 API 或前端
  3. 03按现有环境裁剪部署架构
  4. 04为实现方案确定身份与网络边界

MCP 相关

CAIRA 指示可通过 GitHub MCP server 检查参考架构;也可使用 GitHub raw URLs 或临时克隆仓库。

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/microsoft/caira --skill caira

安装后在 Claude Code 中输入/caira确认已加载。

详细介绍

CAIRA

当用户想要构建或扩展生成式 AI 解决方案时,使用此技能。CAIRA 是一个参考库,而不是应用生成器:检查代码库,选择最小范围的相关参考组件,并将其改编到用户的工作区中。

生成更改前的信息收集

只询问选择组件所需的信息:

  1. 用户想要实现什么目标?
  2. 用户是否已有 Foundry/OpenAI 端点、托管环境、身份验证、可观测性或前端/API 代码?
  3. 需要何种网络隔离或安全边界?
  4. 用户偏好哪些编程语言或框架?如果用户偏好的技术不在 CAIRA 参考中,尝试遵循 CAIRA 参考组件所展示的相同架构模式和设计原则,但要适配用户偏好的语言或框架。
  5. 目前需要哪些组件:Foundry、Container Apps、API、前端,还是仅应用代码?如果用户的回答表明他们只需要一个组件,则只使用该组件。

核心规则

  • 将 github.com/microsoft/caira/ 代码库中的 reference-architectures 目录作为权威信息来源。可以通过 GitHub MCP 服务(如果可用)、GitHub 原始文件 URL,或临时克隆代码库并在本地检查 reference-architectures/ 来查看它。
  • 查看参考架构时,阅读所需组件的完整代码。不要只看 README 或文档。代码才是权威信息来源。
  • 优先使用小型组件参考,而不是复制完整技术栈。
  • 对于需要兼容 OpenAI 的端点的场景,优先使用 Foundry IaC 参考,除非用户已有端点或要求采用其他方案。
  • 提出新的基础设施方案前,先了解用户已有的资源。
  • 始终使用托管身份或其他无密码身份验证模式。绝不使用 API 密钥、静态凭据或机密,除非用户明确要求采用基于 API 密钥或机密的方案。
  • 为 Foundry 实现 IaC 时,使用参考架构中展示的 Azure Verified Module。不要使用与 Foundry 相关的独立 Terraform 资源,除非用户明确要求。
  • 如果需要实现与 Foundry 通信的 API,始终优先使用 Foundry 资源,而不是 Azure OpenAI 资源,除非用户明确要求使用 Azure OpenAI。即使使用 OpenAI Agents SDK,也遵循此规则。
  • 在提出代码库安全扫描方案前,检查目标代码库是否已使用或配置 Gitleaks、Trivy 或类似工具来扫描机密、依赖项、容器或 IaC。如果缺少类似扫描工具,在实施前询问用户是否要添加 Gitleaks 和/或 Trivy 扫描。
  • 让建议聚焦于下方列出的当前参考组件。
  • 说明建议或生成文件参考了哪些 CAIRA 路径。
  • 始终提出后续问题,以进一步明确用户需求,避免不必要地复制参考代码。
  • 开始实施前,确认用户的场景、需求,以及将使用哪些 CAIRA 参考组件、配置、网络和安全边界。

当前参考组件

需求CAIRA 参考路径
Foundry 基础架构reference-architectures/iac/foundry/
用于 API + 前端托管的 Container Appsreference-architectures/iac/container-apps/
使用 OpenAI Agents SDK 的 TypeScript APIreference-architectures/app/api/typescript/openai-agents-sdk/
使用 Foundry Agent Service 的 TypeScript APIreference-architectures/app/api/typescript/foundry-agent-service/
使用 Microsoft Agent Framework 的 C# APIreference-architectures/app/api/csharp/microsoft-agent-framework/
React 前端reference-architectures/app/frontend/typescript/react/
前端/API 契约reference-architectures/app/API_CONTRACT.md

如何使用 CAIRA 参考内容

  1. 检查相关组件源文件。
  2. 仅复制或改编用户技术栈所需的文件。
  3. 删除不适用于用户场景的示例文本、模型名称、环境变量或 Terraform 变量。
  4. 保留组件的验证方式:TypeScript 使用 npm 脚本,C# 使用 .NET 构建,IaC 使用 Terraform 验证,容器使用 Docker 构建。
  5. 说明使用的 CAIRA 确切路径,以及有意省略的内容。

评论

支持 Markdown