article
README
🚀 AWS MCP 服务器
AWS MCP 服务器是一个类似于 AWS CLI 的服务,它能够帮助用户轻松连接到 AWS 账户,为管理 AWS 服务提供了便利。
🚀 快速开始
按照以下步骤,你可以快速启动并使用 AWS MCP 服务器:
- 安装依赖:
npm install
- 配置 AWS 凭证:
- 复制
.env.example文件并重命名为.env - 在
.env文件中填写你的 AWS 凭证信息:
- 复制
AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_REGION=your-region
- 若使用临时凭证(访问密钥以 `ASIA` 开头),请确保包含会话令牌:
AWS_SESSION_TOKEN=your-session-token
- 设置 Git 钩子,防止敏感信息推送到版本控制:
npm install -g Husky
npx husky init
- 启动服务器:
node .
✨ 主要特性
- 凭证连接:可使用凭证连接到 AWS 账户。
- 多服务支持:支持多种 AWS 服务。
- 凭证管理:具备类似于 AWS CLI 的凭证管理功能。
- 配置文件驱动:基于配置文件实现各项功能。
📦 安装指南
安装依赖
运行以下命令安装项目所需依赖:
npm install
配置 AWS 凭证
- 复制
.env.example文件并重命名为.env。 - 编辑
.env文件,填入你的 AWS 凭证信息:
AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_REGION=your-region
- 若使用临时凭证(访问密钥以
ASIA开头),需添加会话令牌:
AWS_SESSION_TOKEN=your-session-token
设置 Git 钩子
为避免敏感信息被推送到版本控制,执行以下命令:
npm install -g Husky
npx husky init
启动服务器
使用以下命令启动服务器:
node .
💻 使用示例
基础用法
- 访问 S3 存储桶:在浏览器中输入
http://localhost:3000/api/s3/buckets - 访问 EC2 实例:在浏览器中输入
http://localhost:3000/api/ec2/instances
📚 详细文档
开发环境
在开发环境中,你可以使用以下命令启动服务器:
npm run dev
测试验证
运行以下命令进行测试验证:
npm test
🔧 技术细节
文件结构
src/aws-mcp-server/
├── .env.example # 示例环境变量文件
├── .gitignore # Git 忽略文件
├── README.md # 文档说明
├── package.json # 项目依赖
└── src/ # 源代码
├── config/ # 配置文件
│ └── aws-config.js # AWS SDK 配置
├── core/ # 核心功能(目前为空)
├── index.js # 主入口点
├── services/ # AWS 服务实现
│ ├── ec2.js # EC2 服务端点
│ ├── lambda.js # Lambda 服务端点
│ └── s3.js # S3 服务端点
└── utils/ # 工具函数
├── logger.js # 日志工具
└── session-manager.js # AWS 会话管理工具
Scan to contact