mcp-aws-manager 0.3.2 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/MCP_CLIENT_SETUP.md +2 -18
- package/README.md +7 -143
- package/package.json +2 -4
package/MCP_CLIENT_SETUP.md
CHANGED
|
@@ -4,7 +4,6 @@ This project provides an MCP stdio wrapper around the SSM-first AWS operations C
|
|
|
4
4
|
|
|
5
5
|
- Preferred CLI command: `mcp-aws-manager`
|
|
6
6
|
- Preferred MCP server command: `mcp-aws-manager-mcp`
|
|
7
|
-
- Compatibility aliases: `mcp-aws-discover`, `mcp-aws-discover-mcp`
|
|
8
7
|
|
|
9
8
|
Exposed MCP tools:
|
|
10
9
|
|
|
@@ -29,19 +28,8 @@ mcp-aws-manager doctor
|
|
|
29
28
|
|
|
30
29
|
## Agent-Led Setup Flow
|
|
31
30
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
1. `mcp-aws-manager doctor`
|
|
35
|
-
2. If AWS auth missing, guide:
|
|
36
|
-
- `aws configure sso --profile default`
|
|
37
|
-
- `aws sso login --profile default`
|
|
38
|
-
3. Validate:
|
|
39
|
-
- `aws sts get-caller-identity --profile default`
|
|
40
|
-
4. Validate MCP discovery path:
|
|
41
|
-
- `mcp-aws-manager discover --profiles default --no-progress`
|
|
42
|
-
5. If `requiresUserAction=true`, ask for one manual action only, then retry same request.
|
|
43
|
-
|
|
44
|
-
Manual user actions are typically limited to SSO browser/MFA and IAM approval.
|
|
31
|
+
Detailed onboarding flow is maintained in `USAGE_GUIDE.md` ("Agent-Assisted First-Time Setup").
|
|
32
|
+
This document only covers MCP server registration/configuration.
|
|
45
33
|
|
|
46
34
|
## Explicit Registration
|
|
47
35
|
|
|
@@ -115,8 +103,4 @@ Use only when automatic registration is unavailable in your environment.
|
|
|
115
103
|
|
|
116
104
|
- Discovery is SSM-first for host/runtime access; PEM path arguments are no longer required.
|
|
117
105
|
- Runtime execution uses this package's internal AWS SDK/CLI path only (no external AWS management MCP backend dependency).
|
|
118
|
-
- Use include flags (`includeLambda`, `includeAlb`, `includeAsg`, `includeRds`, `includeElastiCache`, `includeRoute53`) to expand inventory scope.
|
|
119
|
-
- Keep AWS credentials/profiles available on the host running MCP.
|
|
120
|
-
- When `requiresUserAction=true` is returned, use `guidance.assistantMessageTemplate` to prompt the user, then retry with `guidance.retryTool` + `guidance.retryArgs` after user confirmation.
|
|
121
|
-
- For auto remediation, pass `autoRemediateSsm` and an instance profile name/arn.
|
|
122
106
|
- Supported setup clients: `codex`, `claude`, `cursor`, `windsurf`, `antigravity`.
|
package/README.md
CHANGED
|
@@ -42,150 +42,14 @@ This ensures `mcp-aws-manager` is registered in detected clients (`codex`, `clau
|
|
|
42
42
|
|
|
43
43
|
For first-time users, follow the agent-assisted onboarding flow in `USAGE_GUIDE.md` ("Agent-Assisted First-Time Setup").
|
|
44
44
|
|
|
45
|
-
##
|
|
45
|
+
## Document Map
|
|
46
46
|
|
|
47
|
-
-
|
|
48
|
-
-
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
- For ASG inventory: `autoscaling:DescribeAutoScalingGroups`
|
|
53
|
-
- For RDS inventory: `rds:DescribeDBInstances`
|
|
54
|
-
- For ElastiCache inventory: `elasticache:DescribeCacheClusters`
|
|
55
|
-
- For Route53 inventory: `route53:ListHostedZones` (record counts require `route53:ListResourceRecordSets`)
|
|
47
|
+
- End-user setup and run commands: `USAGE_GUIDE.md`
|
|
48
|
+
- MCP client registration and stdio config: `MCP_CLIENT_SETUP.md`
|
|
49
|
+
- Agent retry/guidance loop template: `AGENT_GUIDANCE_LOOP_TEMPLATE_KO.md`
|
|
50
|
+
- Implementation APIs/CLI wiring: `IMPLEMENTATION_INTEGRATIONS.md`
|
|
51
|
+
- Positioning vs existing AWS MCPs: `MCP_DIFFERENTIATION.md`
|
|
56
52
|
|
|
57
|
-
##
|
|
58
|
-
|
|
59
|
-
Bootstrap / setup / doctor:
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
mcp-aws-manager # bootstrap (default command)
|
|
63
|
-
mcp-aws-manager setup # register/re-register MCP server
|
|
64
|
-
mcp-aws-manager doctor # verify install + registration
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
Basic discovery:
|
|
68
|
-
|
|
69
|
-
```bash
|
|
70
|
-
mcp-aws-manager discover --profiles default
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
Include Lambda inventory together:
|
|
74
|
-
|
|
75
|
-
```bash
|
|
76
|
-
mcp-aws-manager discover --profiles default --include-lambda
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
Include core service topology (ALB/ASG/RDS/ElastiCache/Route53):
|
|
80
|
-
|
|
81
|
-
```bash
|
|
82
|
-
mcp-aws-manager discover \
|
|
83
|
-
--profiles default \
|
|
84
|
-
--include-alb --include-asg --include-rds --include-elasticache --include-route53
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
Lambda-only inventory:
|
|
88
|
-
|
|
89
|
-
```bash
|
|
90
|
-
mcp-aws-manager discover --profiles default --include-lambda --no-ec2 --no-runtime-snapshot
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
Only public IP instances:
|
|
94
|
-
|
|
95
|
-
```bash
|
|
96
|
-
mcp-aws-manager discover --profiles default --public-only
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
Collect runtime snapshots:
|
|
100
|
-
|
|
101
|
-
```bash
|
|
102
|
-
mcp-aws-manager discover --profiles default --runtime-snapshot
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
Try automatic remediation for unmanaged instances:
|
|
106
|
-
|
|
107
|
-
```bash
|
|
108
|
-
mcp-aws-manager discover \
|
|
109
|
-
--profiles default \
|
|
110
|
-
--auto-remediate-ssm \
|
|
111
|
-
--ssm-instance-profile-name MySsmInstanceProfile
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
Output CSV file:
|
|
115
|
-
|
|
116
|
-
```bash
|
|
117
|
-
mcp-aws-manager discover --profiles default --format csv --out ./inventory.csv
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
Compatibility note:
|
|
121
|
-
|
|
122
|
-
- Legacy invocation without subcommand still works for discovery when options are passed.
|
|
123
|
-
- Example: `mcp-aws-manager --profiles default --public-only`
|
|
124
|
-
|
|
125
|
-
## MCP (LLM Tool) Usage
|
|
126
|
-
|
|
127
|
-
Run as an MCP stdio server:
|
|
128
|
-
|
|
129
|
-
```bash
|
|
130
|
-
mcp-aws-manager-mcp
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
Exposed MCP tools:
|
|
134
|
-
|
|
135
|
-
- `discover_ec2_with_ssm` (primary, multi-service inventory + SSM runtime)
|
|
136
|
-
- `discover_public_ec2_with_pem` (compatibility alias, same behavior)
|
|
137
|
-
- `mcp_aws_discover_cli_help`
|
|
138
|
-
|
|
139
|
-
Example tool arguments:
|
|
140
|
-
|
|
141
|
-
```json
|
|
142
|
-
{
|
|
143
|
-
"profiles": ["default"],
|
|
144
|
-
"includeLambda": true,
|
|
145
|
-
"publicOnly": true,
|
|
146
|
-
"runtimeSnapshot": true,
|
|
147
|
-
"autoSsoLogin": true,
|
|
148
|
-
"noProgress": true
|
|
149
|
-
}
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
## Human-in-the-loop Behavior
|
|
153
|
-
|
|
154
|
-
When fully automatic execution is not possible, the CLI/MCP returns actionable guidance:
|
|
155
|
-
|
|
156
|
-
- `ACTION_REQUIRED: [SSO_LOGIN_NEEDED] ...`
|
|
157
|
-
- `ACTION_REQUIRED: [SSM_ROLE_OR_AGENT_REQUIRED] ...`
|
|
158
|
-
- `ACTION_REQUIRED: [IAM_PROFILE_ASSOCIATION_FAILED] ...`
|
|
159
|
-
- `ACTION_REQUIRED: [LAMBDA_LIST_PERMISSION_REQUIRED] ...`
|
|
160
|
-
- `ACTION_REQUIRED: [ELBV2_LIST_PERMISSION_REQUIRED] ...`
|
|
161
|
-
- `ACTION_REQUIRED: [ASG_LIST_PERMISSION_REQUIRED] ...`
|
|
162
|
-
- `ACTION_REQUIRED: [RDS_LIST_PERMISSION_REQUIRED] ...`
|
|
163
|
-
- `ACTION_REQUIRED: [ELASTICACHE_LIST_PERMISSION_REQUIRED] ...`
|
|
164
|
-
- `ACTION_REQUIRED: [ROUTE53_LIST_PERMISSION_REQUIRED] ...`
|
|
165
|
-
|
|
166
|
-
The MCP wrapper surfaces these in a structured `requiredActions` list and a `guidance` object (`assistantMessageTemplate`, `retryTool`, `retryArgs`).
|
|
167
|
-
|
|
168
|
-
For agent orchestration, see:
|
|
169
|
-
|
|
170
|
-
- `AGENT_GUIDANCE_LOOP_TEMPLATE_KO.md`
|
|
171
|
-
|
|
172
|
-
## Security Notes
|
|
173
|
-
|
|
174
|
-
- Prefer IAM role + SSM over SSH key based access.
|
|
175
|
-
- Restrict RunCommand scopes with IAM policies and resource conditions.
|
|
176
|
-
- Review remediation permissions before enabling `--auto-remediate-ssm`.
|
|
177
|
-
|
|
178
|
-
## Compatibility Aliases
|
|
179
|
-
|
|
180
|
-
These legacy commands are still available:
|
|
181
|
-
|
|
182
|
-
- `mcp-aws-discover`
|
|
183
|
-
- `mcp-aws-discover-mcp`
|
|
184
|
-
|
|
185
|
-
## Differentiation Docs
|
|
53
|
+
## Differentiation
|
|
186
54
|
|
|
187
55
|
This project does not delegate runtime execution to other AWS management MCP servers.
|
|
188
|
-
Implementation details and differentiation are documented in:
|
|
189
|
-
|
|
190
|
-
- `IMPLEMENTATION_INTEGRATIONS.md` (implemented MCP/API/CLI inventory)
|
|
191
|
-
- `MCP_DIFFERENTIATION.md` (differences from existing AWS management MCPs)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "mcp-aws-manager",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.3",
|
|
4
4
|
"description": "AWS operations CLI and MCP server (SSM-only) for EC2/Lambda inventory, remediation, and runtime snapshots",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"publishConfig": {
|
|
@@ -18,9 +18,7 @@
|
|
|
18
18
|
],
|
|
19
19
|
"bin": {
|
|
20
20
|
"mcp-aws-manager": "bin/mcp-aws-manager.js",
|
|
21
|
-
"mcp-aws-manager-mcp": "bin/mcp-aws-manager-mcp.js"
|
|
22
|
-
"mcp-aws-discover": "bin/mcp-aws-manager.js",
|
|
23
|
-
"mcp-aws-discover-mcp": "bin/mcp-aws-manager-mcp.js"
|
|
21
|
+
"mcp-aws-manager-mcp": "bin/mcp-aws-manager-mcp.js"
|
|
24
22
|
},
|
|
25
23
|
"files": [
|
|
26
24
|
"bin",
|