项目简介

Guardrails MCP 服务器是基于 Model Context Protocol (MCP) 构建的应用后端，旨在连接 AI 助手（如 Claude）与您的 Turbot Guardrails 环境。它使得 AI 助手能够通过自然语言访问、分析和操作您的云资源、合规状态和策略。

主要功能点

资源查询与分析: 允许 AI 助手使用 GraphQL 查询和分析 Guardrails 中的云资源。
列表与过滤: 提供按类型（资源、控制、策略）列出和过滤信息的能力。
控制操作: 支持执行合规控制项并查看其状态和详情。
架构探索: 允许探索 Guardrails 的 GraphQL 架构，辅助构建自定义查询。
模板处理: 提供使用 Nunjucks 模板处理数据的功能，用于动态配置或报告生成。

安装步骤

前提条件:
- Node.js v20 或更高版本。
- 有效的 Turbot Guardrails API 访问密钥（需具备适当权限）。
- 您的 Guardrails 工作空间 API 端点 URL。
安装 MCP 服务器: 通常通过支持 MCP 的 AI 助手自带的方式安装。您可以直接使用 npx 命令安装和运行它，无需手动克隆仓库或安装依赖：
```
npx @turbot/guardrails-mcp
```
（注意：此命令由 AI 助手在内部执行，用户通常只需配置助手即可。）

服务器配置

MCP 服务器本身通过环境变量获取 Guardrails API 的连接信息。您需要在启动 MCP 服务器的 AI 助手中配置这些环境变量。AI 助手通过其配置文件来管理这些设置。以下是一个示例配置片段（JSON 格式），您需要将其添加到您的 AI 助手配置文件中：

{
  "mcpServers": {
    "turbot-guardrails": {
      // MCP 服务器的启动命令。npx 用于直接运行 npm 包中的可执行文件。
      "command": "npx",
      // 传递给命令的参数。"-y" 自动同意安装包，"@turbot/guardrails-mcp" 指定要运行的包。
      "args": ["-y", "@turbot/guardrails-mcp"],
      // MCP 服务器运行所需的环境变量。
      "env": {
        // 您的 Guardrails GraphQL API 端点 URL。
        "TURBOT_GRAPHQL_ENDPOINT": "https://YOUR_WORKSPACE.cloud.turbot.com/api/latest/graphql",
        // 您的 Guardrails API 访问密钥 ID。
        "TURBOT_ACCESS_KEY_ID": "YOUR_ACCESS_KEY_ID",
        // 您的 Guardrails API 密钥 Secret。
        "TURBOT_SECRET_ACCESS_KEY": "YOUR_SECRET_ACCESS_KEY"
      }
    }
  }
}

替换 'YOUR_WORKSPACE.cloud.turbot.com', 'YOUR_ACCESS_KEY_ID', 'YOUR_SECRET_ACCESS_KEY' 为您实际的 Guardrails 环境信息。配置完成后，重启您的 AI 助手使配置生效。

基本使用方法

配置并启动 AI 助手后，您可以直接在与 AI 助手的对话中使用自然语言提问，AI 助手将利用 Guardrails MCP 服务器的能力来回答您的问题或执行操作。

例如，您可以尝试以下类型的提问：

"Guardrails 中有哪些 AWS 账号？"
"显示所有上周创建的 S3 存储桶。"
"列出所有不符合标记标准的 EC2 实例。"
"展示所有与加密相关的策略类型。"
"显示资源 ID 1234567890 的详细信息。"
"运行 ID 为 4567890123 的控制项。"

提示:

尽量具体说明您想要分析的资源、控制或策略。
可以使用筛选条件来缩小范围，例如按类别、标题或标签筛选。
可以先从简单的查询开始，再逐步增加复杂条件。
直接使用自然语言提问，AI 助手会负责将您的提问转化为 MCP 服务器能够理解的请求。

关键词

信息