mcp-aws-manager 0.3.4 → 0.3.6

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/README_KO.md ADDED
@@ -0,0 +1,115 @@
1
+ # mcp-aws-manager (한국어 안내)
2
+
3
+ AWS 운영 작업용 CLI + MCP stdio 서버입니다.
4
+
5
+ 이 패키지는 AWS 인벤토리/런타임/완화 작업을 정규화된 출력 스키마와 `ACTION_REQUIRED` 가이드로 제공합니다. 단순 AWS CLI 래퍼가 아니라, 에이전트 친화적인 운영 워크플로우를 목표로 합니다.
6
+
7
+ ## 빠른 시작
8
+
9
+ ```bash
10
+ npm install -g mcp-aws-manager
11
+ mcp-aws-manager
12
+ mcp-aws-manager doctor
13
+ mcp-aws-manager discover --profiles default --no-progress
14
+ ```
15
+
16
+ ## 핵심 기능
17
+
18
+ - 멀티 서비스 인벤토리: EC2, Lambda, ALB/NLB, ASG, RDS, ElastiCache, Route53
19
+ - SSM 상태 확인: managed/online
20
+ - 런타임 스냅샷(선택), SSM 완화(선택)
21
+ - AWS 인증이 안 될 때 수동 모드: JSON/CSV 서버 목록 + PEM SSH
22
+ - GUI 리포트 생성: `--html-out` (검색/필터/CSV 다운로드 버튼 포함)
23
+ - 사람이 개입해야 할 상황을 `ACTION_REQUIRED`로 표준화
24
+
25
+ ## 바이너리
26
+
27
+ - CLI: `mcp-aws-manager`
28
+ - MCP stdio server: `mcp-aws-manager-mcp`
29
+
30
+ ## 최초 설정(권장 흐름)
31
+
32
+ 1. 설치 및 부트스트랩
33
+
34
+ ```bash
35
+ npm.cmd install -g mcp-aws-manager@latest
36
+ mcp-aws-manager
37
+ ```
38
+
39
+ 2. 상태 확인
40
+
41
+ ```bash
42
+ mcp-aws-manager doctor
43
+ ```
44
+
45
+ 3. AWS 인증 설정(권장: SSO)
46
+
47
+ ```bash
48
+ aws configure sso --profile default
49
+ aws sso login --profile default
50
+ ```
51
+
52
+ 4. 인증 확인
53
+
54
+ ```bash
55
+ aws sts get-caller-identity --profile default
56
+ ```
57
+
58
+ 5. 인벤토리 실행
59
+
60
+ ```bash
61
+ mcp-aws-manager discover --profiles default --no-progress
62
+ ```
63
+
64
+ ## 인증 불가 시 수동 모드
65
+
66
+ ```bash
67
+ mcp-aws-manager discover --manual-server-list ./servers.csv --pem-paths C:\keys\prod.pem --no-progress
68
+ ```
69
+
70
+ ## GUI 리포트
71
+
72
+ ```bash
73
+ mcp-aws-manager discover --profiles default --html-out ./inventory.html --open-html --no-progress
74
+ ```
75
+
76
+ - `--html-out <path>`: 인터랙티브 HTML 리포트 생성
77
+ - `--open-html`: 생성 후 브라우저 자동 오픈 시도
78
+ - GUI에서 현재 뷰 기준 CSV 다운로드 가능
79
+
80
+ ## MCP 도구
81
+
82
+ 조회:
83
+
84
+ - `discover_ec2_with_ssm`
85
+ - `mcp_aws_discover_cli_help`
86
+
87
+ 변경:
88
+
89
+ - `ec2_start_instances`
90
+ - `ec2_stop_instances`
91
+ - `ec2_reboot_instances`
92
+ - `ec2_apply_instance_profile`
93
+
94
+ 예시:
95
+
96
+ - `ec2_start_instances`: `{ "profile": "default", "region": "ap-southeast-1", "instanceIds": ["i-123"] }`
97
+ - `ec2_apply_instance_profile`: `{ "profile": "default", "region": "ap-southeast-1", "instanceId": "i-123", "instanceProfileName": "my-ssm-profile", "allowReplaceProfile": true }`
98
+
99
+ ## 자주 쓰는 ACTION_REQUIRED
100
+
101
+ - 인증: `SSO_LOGIN_NEEDED`, `AWS_CREDENTIALS_REQUIRED`
102
+ - 권한: `IAM_PERMISSION_REQUIRED`, `AWS_OPERATION_FAILED`
103
+ - SSM/런타임: `SSM_ROLE_OR_AGENT_REQUIRED`, `SSM_RUNCOMMAND_PERMISSION_REQUIRED`
104
+ - 수동 모드: `MANUAL_SERVER_LIST_EMPTY`, `MANUAL_SERVER_HOST_REQUIRED`, `PEM_KEY_NOT_FOUND`, `PEM_MAPPING_REQUIRED`, `SSH_CLIENT_NOT_FOUND`
105
+
106
+ ## 한국어 관련 문서
107
+
108
+ - `MCP_CLIENT_SETUP_KO.md`
109
+ - `AWS_SSO_SETUP_GUIDE_KO.md`
110
+
111
+ ## 원문(영문) 문서
112
+
113
+ - `README.md`
114
+ - `MCP_CLIENT_SETUP.md`
115
+ - `AWS_SSO_SETUP_GUIDE.md`