197 lines
12 KiB
Markdown
197 lines
12 KiB
Markdown
<!-- WEHUB_ZH_README -->
|
||
> [!NOTE]
|
||
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
|
||
> [English](./README.en.md) · [原始项目](https://github.com/aws/agent-toolkit-for-aws) · [上游 README](https://github.com/aws/agent-toolkit-for-aws/blob/HEAD/README.md)
|
||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||
|
||
# Agent Toolkit for AWS
|
||
|
||
[](LICENSE)
|
||
[](https://github.com/aws/agent-toolkit-for-aws/actions/workflows/build.yml)
|
||
[](https://github.com/aws/agent-toolkit-for-aws)
|
||
|
||
帮助 AI 编程智能体在 AWS 上构建、部署和管理应用程序。
|
||
|
||
Agent Toolkit for AWS 为 AI 编程智能体提供使用 AWS 服务所需的工具、知识与护栏(guardrails)。它可与开发者已在使用的编程智能体配合使用——包括 Claude Code、Codex、Cursor 和 Kiro。
|
||
|
||
## 快速入门
|
||
|
||
### AWS CLI
|
||
|
||
通过 AWS CLI 在终端中直接使用 Agent Toolkit:
|
||
|
||
```
|
||
aws configure agent-toolkit
|
||
```
|
||
|
||
请参阅 [AWS CLI 集成指南](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/aws-cli.html) 了解设置、配置和使用说明。
|
||
|
||
### Claude Code
|
||
|
||
插件可在官方 Anthropic 市场(`claude-plugins-official`)获取,该市场默认会添加到 Claude Code 安装中。
|
||
使用以下命令从工具包安装受支持的插件:
|
||
|
||
适用于 `aws-core`,涵盖服务选择、CDK/CloudFormation、无服务器(serverless)、容器、存储、可观测性、计费、SDK 使用及部署:
|
||
|
||
```
|
||
/plugin install aws-core@claude-plugins-official
|
||
```
|
||
|
||
> **提示:** 若出现 `Plugin not found`,请先更新本地市场索引:
|
||
>
|
||
> ```
|
||
> /plugin marketplace update claude-plugins-official
|
||
> ```
|
||
|
||
适用于 `aws-agents`,涵盖使用 Amazon Bedrock 和 AgentCore 在 AWS 上构建 AI 智能体:
|
||
|
||
```
|
||
/plugin install aws-agents@claude-plugins-official
|
||
```
|
||
|
||
适用于 `aws-data-analytics`,涵盖使用 S3 Tables、AWS Glue 和 Athena 的数据湖、分析与 ETL 工作流:
|
||
|
||
```
|
||
/plugin install aws-data-analytics@claude-plugins-official
|
||
```
|
||
|
||
适用于 `aws-agents-for-devsecops`,用于调查事件、审查代码并执行 UAT(用户验收测试)以评估发布就绪度、扫描代码漏洞,以及使用 AWS DevOps Agent 和 AWS Security Agent 运行渗透测试。
|
||
|
||
```
|
||
/plugin marketplace add aws/agent-toolkit-for-aws
|
||
/plugin install aws-agents-for-devsecops
|
||
/reload-plugins
|
||
|
||
# Or from Claude's official marketplace:
|
||
/plugin install aws-agents-for-devsecops@claude-plugins-official
|
||
/reload-plugins
|
||
|
||
# Setup:
|
||
/aws-agents-for-devsecops:setup
|
||
```
|
||
|
||
### Codex
|
||
|
||
在终端中:
|
||
|
||
```
|
||
codex plugin marketplace add aws/agent-toolkit-for-aws
|
||
```
|
||
|
||
然后启动 Codex 并运行 `/plugins` 以浏览并安装 **aws-core** 插件。
|
||
|
||
### Cursor
|
||
|
||
通过 **Settings → Plugins → Team Marketplaces → Add Marketplace → Import from Repo** 将此仓库添加为团队市场,指向 `aws/agent-toolkit-for-aws`。Cursor 在导入时会索引 [`.cursor-plugin/marketplace.json`](.cursor-plugin/marketplace.json) 中列出的插件。
|
||
|
||
然后打开 **Plugins** 面板并安装 **aws-core** 插件(从这里开始),或按需安装 **aws-agents** 和 **aws-data-analytics**。每个插件都捆绑了 AWS MCP Server 配置和 agent skills。
|
||
|
||
### Kiro
|
||
|
||
Kiro 设置包含两个独立部分:AWS MCP Server(用于运行时 AWS API 访问和文档搜索)以及本地 skills(用于特定任务的智能体指导)。两者相互补充但可独立工作——skills 不需要 MCP server,MCP server 也不会提供本地安装的 skills。
|
||
|
||
**1. 将 AWS MCP Server 添加到** 你的 Kiro MCP 配置(`.kiro/settings/mcp.json`):
|
||
|
||
```json
|
||
{
|
||
"mcpServers": {
|
||
"aws": {
|
||
"command": "uvx",
|
||
"args": [
|
||
"mcp-proxy-for-aws@1.6.3",
|
||
"https://aws-mcp.us-east-1.api.aws/mcp",
|
||
"--metadata",
|
||
"AWS_REGION=us-west-2"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
> **注意:** 建议固定到特定版本(例如 `@1.6.3`),以确保行为可复现并防范供应链风险。我们建议定期检查 [PyPI](https://pypi.org/project/mcp-proxy-for-aws/) 以获取新的稳定版本并相应更新。
|
||
|
||
MCP server 让你的智能体能够访问 AWS API、沙箱化脚本执行以及实时文档搜索。
|
||
|
||
**2. 从此仓库安装 skills:**
|
||
|
||
```
|
||
npx skills add aws/agent-toolkit-for-aws/skills
|
||
```
|
||
|
||
这会将 skill 文件安装到 `~/.kiro/skills/`(全局)或 `.kiro/skills/`(项目级)。每个 skill 是一个目录,其中包含 `SKILL.md` 文件,以及可选的 `references/` 子目录(其中包含智能体在需要时从本地文件系统读取的额外上下文)。Kiro 会自动发现已安装的 skills,并在任务匹配时按需激活它们。
|
||
|
||
> **前置条件:** 你需要安装 [uv](https://docs.astral.sh/uv/)。要进行 API 调用和脚本执行,需要在本地配置凭证的 AWS 账户,但文档搜索和 skill 发现不需要。请参阅[用户指南](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/) 了解详细设置说明。
|
||
|
||
### 其他智能体
|
||
|
||
请参阅 [AWS MCP Server 入门指南](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/getting-started-aws-mcp-server.html) 了解如何为你的智能体配置 AWS MCP Server。
|
||
|
||
然后从此仓库安装 skills:
|
||
|
||
```
|
||
npx skills add aws/agent-toolkit-for-aws/skills
|
||
```
|
||
|
||
> **前置条件:** 你需要安装 [uv](https://docs.astral.sh/uv/)。要进行 API 调用和脚本执行,需要在本地配置凭证的 AWS 账户,但文档搜索和 skill 发现不需要。请参阅[用户指南](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/) 了解详细设置说明。
|
||
|
||
## 包含内容
|
||
|
||
### 插件
|
||
|
||
插件将 AWS MCP Server 配置和 agent skills 打包为单一安装包,供你的编程智能体使用。
|
||
|
||
| Plugin | Description |
|
||
| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| [aws-core](plugins/aws-core/) | 核心 AWS skills 和 MCP Server 配置。涵盖服务选择、CDK/CloudFormation、无服务器(serverless)、容器、存储、可观测性、计费、SDK 使用及部署。**从这里开始。** |
|
||
| [aws-agents](plugins/aws-agents/) | 用于使用 Amazon Bedrock 和 AgentCore 在 AWS 上构建 AI 智能体的 skills。 |
|
||
| [aws-data-analytics](plugins/aws-data-analytics/) | 用于使用 S3 Tables、AWS Glue 和 Athena 进行数据湖、分析与 ETL 工作流的 skills。 |
|
||
| [aws-agents-for-devsecops](plugins/aws-agents-for-devsecops/) | 调查事件、审查代码并执行 UAT 以评估发布就绪度、扫描代码漏洞,并使用 [AWS DevOps Agent](https://aws.amazon.com/devops-agent/?trk=7b4b0d25-1409-441c-b914-c5d08677c376&sc_channel=ghr) 和 [AWS Security Agent](https://aws.amazon.com/security-agent/?trk=7b4b0d25-1409-441c-b914-c5d08677c376&sc_channel=ghr). 运行渗透测试。 |
|
||
|
||
插件目前适用于 Claude Code、Codex 和 Cursor。对于其他智能体(agent),请直接配置 AWS MCP Server,并从本仓库安装 skills。
|
||
|
||
### Skills
|
||
|
||
Agent skills(智能体技能)是经过精心编排的指令与参考资料包,可帮助智能体完成特定的 AWS 任务。Skills 按需加载——智能体只会发现并获取与当前任务相关的内容。
|
||
|
||
```
|
||
npx skills add aws/agent-toolkit-for-aws/skills
|
||
```
|
||
|
||
浏览 [`skills/`](skills/) 目录以查看所有可用 skills。
|
||
|
||
### Rules files
|
||
|
||
推荐的项目级配置文件,用于指导智能体如何最有效地使用 AWS——例如,通过 AWS MCP Server、发现可用 skills,或在执行操作前搜索文档。
|
||
|
||
详见 [`rules/`](rules/)。
|
||
|
||
### AWS MCP Server
|
||
|
||
[AWS MCP Server](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/understanding-mcp-server-tools.html) 是一项托管服务,通过 Model Context Protocol(MCP)为智能体提供访问 AWS 的能力。它提供:
|
||
|
||
- **完整 AWS API 覆盖** — 通过单一已认证端点与 300 多项 AWS 服务中的任意服务交互。
|
||
- **沙箱化脚本执行** — 智能体可在隔离环境中运行 Python 脚本,以完成复杂的多步骤操作。
|
||
- **实时文档访问** — 无需身份验证即可搜索并获取最新的 AWS 文档、API 参考及服务能力说明。
|
||
- **企业级管控** — Amazon CloudWatch 指标、用于智能体专属策略的 IAM 上下文键(context keys),以及 AWS CloudTrail 审计日志记录。
|
||
|
||
有关运行机制、可用工具、身份验证及支持区域的详细信息,请参阅 [AWS MCP Server 文档](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/understanding-mcp-server-tools.html).
|
||
|
||
## Documentation
|
||
|
||
- [用户指南](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/) — 安装、配置及参考文档。
|
||
- [AWS MCP Server 工具](https://docs.aws.amazon.com/agent-toolkit/latest/userguide/understanding-mcp-server-tools.html) — 所有可用 MCP 工具的参考说明。
|
||
|
||
## How the Agent Toolkit relates to the MCP servers, skills, and plugins in AWS Labs
|
||
|
||
2025 年,AWS 开始将 MCP 服务器、skills 和 plugins 作为 [AWS Labs](https://github.com/awslabs). 的一部分发布。Agent Toolkit for AWS 是这些工具的继任者。我们建议使用 Agent Toolkit for AWS,因为它提供以下关键特性:
|
||
|
||
- IAM 条件键(condition keys)可区分智能体操作与人工操作,因此您可以编写仅适用于智能体的策略。例如,即使用户底层 IAM 角色具备写入权限,您也可以编写策略,仅允许通过 MCP 服务器执行只读操作)。
|
||
- 为每个请求提供 CloudWatch 指标与 CloudTrail 审计日志记录,便于您监控并审计编程智能体的活动。
|
||
- 经过全面端到端评估的 Agent skills,让您对工作流能够成功完成更有信心。
|
||
|
||
[AWS Labs](https://github.com/awslabs) 的 MCP 服务器、skills 和 plugins 将继续可用并接受贡献;随着时间推移,AWS Labs 中最优秀的内容将迁移至 Agent Toolkit for AWS,以确保客户能够为其智能体获取最广泛的工具与指导。
|
||
|
||
## License
|
||
|
||
本项目采用 Apache-2.0 License 许可。详情请参阅 [LICENSE](LICENSE)。
|