awslabs.well-architected-security-mcp-server 0.1.1__py3-none-any.whl

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.
@@ -0,0 +1,258 @@
1
+ Metadata-Version: 2.4
2
+ Name: awslabs.well-architected-security-mcp-server
3
+ Version: 0.1.1
4
+ Summary: AWS Well-Architected Security Assessment Tool MCP Server
5
+ Requires-Python: >=3.10
6
+ Requires-Dist: boto3>=1.28.0
7
+ Requires-Dist: fastapi>=0.100.0
8
+ Requires-Dist: loguru>=0.7.0
9
+ Requires-Dist: mcp[server]>=1.7.1
10
+ Requires-Dist: pydantic>=2.0.0
11
+ Requires-Dist: pyright>=1.1.0
12
+ Requires-Dist: pytest-asyncio>=0.26.0
13
+ Requires-Dist: pytest-cov>=4.1.0
14
+ Requires-Dist: pytest-mock>=3.12.0
15
+ Requires-Dist: pytest>=7.0.0
16
+ Requires-Dist: ruff>=0.0.291
17
+ Description-Content-Type: text/markdown
18
+
19
+ # AWS Well-Architected Security Assessment Tool MCP Server
20
+
21
+ [![PyPI version](https://img.shields.io/pypi/v/awslabs.well-architected-security-mcp-server.svg)](https://pypi.org/project/awslabs.well-architected-security-mcp-server/)
22
+
23
+ A Model Context Protocol (MCP) server that provides operational tools for monitoring and assessing AWS environments against the AWS Well-Architected Framework Security Pillar. This server enables AI assistants to help operations teams evaluate security posture, monitor compliance status, and optimize security costs while maintaining operational excellence according to the Well-Architected Framework.
24
+
25
+ ## Features
26
+
27
+ - **Operational Security Monitoring**: Monitor status of AWS security services (GuardDuty, Security Hub, Inspector, IAM Access Analyzer) across your infrastructure
28
+ - **Security Operations Dashboard**: Retrieve and analyze security findings from AWS services for operational visibility
29
+ - **Compliance Operations**: Continuously assess security posture against Well-Architected Framework for operational compliance
30
+ - **Resource Operations**: Discover and monitor AWS resources across multiple services and regions for security operations
31
+ - **Cost-Effective Data Protection**: Monitor storage configuration for encryption compliance while optimizing security costs
32
+ - **Network Operations Security**: Verify network configuration for encryption compliance in operational environments
33
+ - **Compliance Monitoring**: Monitor compliance status of AWS resources against security standards for operational reporting
34
+ - **Security Operations Context**: Access stored security context data for operational analysis and trending
35
+
36
+ Operations teams can use the `CheckSecurityServices` tool to monitor if critical AWS security services are operational across their infrastructure. The `GetSecurityFindings` tool provides operational visibility into security findings, while `AnalyzeSecurityPosture` delivers comprehensive security operations reporting against the Well-Architected Framework. The `ExploreAwsResources` tool provides operational inventory capabilities across services and regions to ensure complete operational visibility and cost optimization of the AWS environment.
37
+
38
+ ## Installation
39
+
40
+ ```bash
41
+ # Install using uv
42
+ uv pip install awslabs.well-architected-security-mcp-server
43
+
44
+ # Or install using pip
45
+ pip install awslabs.well-architected-security-mcp-server
46
+ ```
47
+
48
+ You can also run the MCP server directly from a local clone of the GitHub repository:
49
+
50
+ ```bash
51
+ # Clone the awslabs repository
52
+ git clone https://github.com/awslabs/mcp.git
53
+
54
+ # Run the server directly using uv
55
+ uv --directory /path/to/well-architected-security-mcp-server/src/well-architected-security-mcp-server/awslabs/well_architected_security_mcp_server run server.py
56
+ ```
57
+
58
+ ## Usage Environments
59
+
60
+ The AWS Well-Architected Security Assessment Tool MCP Server is designed for operational use across the following environments:
61
+
62
+ - **Production Operations**: Monitor security posture and compliance status in production environments for operational excellence.
63
+ - **Compliance Operations**: Perform ongoing compliance monitoring and reporting for regulatory and internal requirements.
64
+ - **Security Operations Center (SOC)**: Integrate with SOC workflows for continuous security monitoring and incident response.
65
+ - **Cost Optimization**: Monitor security service costs and optimize security spending while maintaining compliance.
66
+ - **Operational Reporting**: Generate security operations reports and dashboards for stakeholders and management.
67
+
68
+ **Operational Considerations**:
69
+ - **Automated Remediation**: While the tool provides operational visibility, automated remediation should be implemented through separate operational workflows.
70
+ - **Monitoring Integration**: Designed for integration with existing monitoring and alerting systems for comprehensive operational coverage.
71
+
72
+ **Important Note on Security Data**: When connecting to any environment, especially production, always prevent accidental exposure of sensitive security information.
73
+
74
+ ## Operational Deployment Considerations
75
+
76
+ The AWS Well-Architected Security Assessment Tool MCP Server is designed for operational deployment across various environments with appropriate operational controls.
77
+
78
+ ### Operational Use Cases
79
+
80
+ The tool is well-suited for operational deployment in the following scenarios:
81
+
82
+ 1. **Security Operations Monitoring**: Continuous monitoring of security posture and compliance status
83
+ 2. **Operational Compliance Reporting**: Regular compliance verification and reporting workflows
84
+ 3. **Cost Operations**: Monitoring security service costs and optimizing security spending
85
+ 4. **Operational Dashboards**: Integration with operational dashboards and monitoring systems
86
+
87
+ ### Operational Best Practices
88
+
89
+ For optimal operational deployment:
90
+
91
+ 1. **Rate Limiting**: Implement appropriate rate limiting to avoid impacting AWS API limits
92
+ 2. **Monitoring Integration**: Integrate with existing operational monitoring and alerting systems
93
+ 3. **Access Controls**: Implement proper IAM controls and operational access patterns
94
+ 4. **Cost Monitoring**: Monitor API costs and optimize query patterns for cost efficiency
95
+
96
+ ## Configuration
97
+
98
+
99
+ | Cursor | VS Code |
100
+ |:------:|:-------:|
101
+ | [![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/en/install-mcp?name=awslabs.well-architected-security-mcp-server&config=eyJjb21tYW5kIjoidXZ4IGF3c2xhYnMud2VsbC1hcmNoaXRlY3RlZC1zZWN1cml0eS1tY3Atc2VydmVyQGxhdGVzdCIsImVudiI6eyJBV1NfUFJPRklMRSI6InlvdXItYXdzLXByb2ZpbGUiLCJBV1NfUkVHSU9OIjoidXMtZWFzdC0xIiwiRkFTVE1DUF9MT0dfTEVWRUwiOiJFUlJPUiJ9LCJkaXNhYmxlZCI6ZmFsc2UsImF1dG9BcHByb3ZlIjpbXX0K) | [![Install on VS Code](https://img.shields.io/badge/Install-VS_Code-FF9900?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=AWS%20Well-Architected%20Security%20Assessment%20Tool%20MCP%20Server&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22awslabs.well-architected-security-mcp-server%40latest%22%5D%2C%22env%22%3A%7B%22AWS_PROFILE%22%3A%22your-aws-profile%22%2C%22AWS_REGION%22%3A%22us-east-1%22%2C%22FASTMCP_LOG_LEVEL%22%3A%22ERROR%22%7D%2C%22disabled%22%3Afalse%2C%22autoApprove%22%3A%5B%5D%7D) |
102
+
103
+ Add the AWS Well-Architected Security Assessment Tool MCP Server to your MCP client configuration:
104
+
105
+ ```json
106
+ {
107
+ "mcpServers": {
108
+ "well-architected-security-mcp-server": {
109
+ "command": "uvx",
110
+ "args": ["--from", "awslabs.well-architected-security-mcp-server", "well-architected-security-mcp-server"],
111
+ "env": {
112
+ "AWS_PROFILE": "your-aws-profile", // Optional - uses your local AWS configuration if not specified
113
+ "AWS_REGION": "your-aws-region", // Optional - uses your local AWS configuration if not specified
114
+ "FASTMCP_LOG_LEVEL": "ERROR"
115
+ }
116
+ }
117
+ }
118
+ }
119
+ ```
120
+
121
+ If running from a local repository, configure the MCP client like this:
122
+
123
+ ```json
124
+ {
125
+ "mcpServers": {
126
+ "well-architected-security-mcp-server": {
127
+ "command": "uv",
128
+ "args": [
129
+ "--directory",
130
+ "/path/to/well-architected-security-mcp-server/src/well-architected-security-mcp-server/awslabs/well_architected_security_mcp_server",
131
+ "run",
132
+ "server.py"
133
+ ],
134
+ "env": {
135
+ "AWS_PROFILE": "your-aws-profile",
136
+ "AWS_REGION": "your-aws-region",
137
+ "FASTMCP_LOG_LEVEL": "DEBUG"
138
+ }
139
+ }
140
+ }
141
+ }
142
+ ```
143
+
144
+ ## Security Controls
145
+
146
+ The AWS Well-Architected Security Assessment Tool MCP Server includes security controls in your MCP client configuration to limit access to sensitive data:
147
+
148
+ ### IAM Best Practices
149
+
150
+ We strongly recommend creating dedicated IAM roles with least-privilege permissions when using the AWS Well-Architected Security Assessment Tool MCP Server:
151
+
152
+ 1. **Create a dedicated IAM role** specifically for security assessment operations
153
+ 2. **Apply least-privilege permissions** by attaching only the necessary read-only policies
154
+ 3. **Use scoped-down resource policies** whenever possible
155
+ 4. **Apply a permission boundary** to limit the maximum permissions
156
+
157
+ For detailed example IAM policies tailored for security assessment use cases, see the AWS documentation for each security service being analyzed.
158
+
159
+ ## MCP Tools
160
+
161
+ ### Security Operations Tools
162
+
163
+ These operational tools help you monitor and manage your AWS security posture against the Well-Architected Framework Security Pillar.
164
+
165
+ - **CheckSecurityServices**: Monitor AWS security services operational status
166
+ - Monitors operational status of GuardDuty, Security Hub, Inspector, and IAM Access Analyzer
167
+ - Identifies service availability across regions for operational visibility
168
+ - Provides operational recommendations for maintaining security service coverage
169
+
170
+ - **GetSecurityFindings**: Operational security findings retrieval
171
+ - Collects operational security findings from Security Hub, GuardDuty, and Inspector
172
+ - Filters findings for operational prioritization by severity, resource type, or service
173
+ - Provides operational context and cost-effective remediation guidance
174
+
175
+ - **GetResourceComplianceStatus**: Operational compliance monitoring
176
+ - Monitors resources against security standards for operational compliance
177
+ - Identifies non-compliant resources for operational remediation workflows
178
+ - Provides compliance metrics and operational improvement recommendations
179
+
180
+ - **GetStoredSecurityContext**: Historical security operations data
181
+ - Retrieves historical security operations data for trend analysis
182
+ - Enables operational comparison of security posture over time
183
+ - Provides operational context for security findings and cost optimization
184
+
185
+ - **ExploreAwsResources**: Operational resource inventory
186
+ - Discovers resources across AWS services for operational visibility
187
+ - Maps resource relationships for operational security context
188
+ - Identifies resources requiring operational security attention
189
+
190
+ - **AnalyzeSecurityPosture**: Comprehensive security operations analysis
191
+ - Evaluates operational security posture against Well-Architected Framework
192
+ - Provides operational recommendations for security improvements and cost optimization
193
+ - Generates operational security metrics and prioritized action items
194
+
195
+ ## Example Prompts
196
+
197
+ ### Security Operations Monitoring
198
+
199
+ - "Monitor the operational status of AWS security services across my account"
200
+ - "Generate an operational security report against the Well-Architected Security Pillar"
201
+ - "Show me current security findings that require operational attention"
202
+ - "Monitor encryption compliance across my S3 buckets for operational reporting"
203
+ - "Verify network encryption compliance for operational security standards"
204
+
205
+ ### Operational Resource Management
206
+
207
+ - "Provide an operational inventory of all resources in my AWS account"
208
+ - "Identify resources with security issues that need operational attention"
209
+ - "List all EC2 instances across regions for security operations review"
210
+ - "Monitor which resources are not compliant with operational security standards"
211
+
212
+ ### Security Operations Analysis
213
+
214
+ - "Analyze operational security posture against Well-Architected best practices"
215
+ - "What security improvements should operations prioritize for cost optimization?"
216
+ - "Compare current security operations metrics with last month's operational baseline"
217
+ - "Generate an operational security dashboard for management reporting"
218
+ - "Monitor security service costs and recommend optimization opportunities"
219
+
220
+ ## Requirements
221
+
222
+ - Python 3.10+
223
+ - AWS credentials with read-only permissions for security services
224
+ - AWS CLI configured with appropriate profiles (optional)
225
+
226
+ ## Testing
227
+
228
+ The AWS Well-Architected Security Assessment Tool MCP Server includes a comprehensive test suite to ensure functionality and reliability. The tests are organized by module and use pytest with mocks to avoid making actual AWS API calls.
229
+
230
+ ### Test Structure
231
+
232
+ - `test_prompt_utils.py`: Tests for prompt template utilities
233
+ - `test_resource_utils.py`: Tests for AWS resource operations
234
+ - `test_storage_security.py`: Tests for storage encryption checks
235
+ - `test_network_security.py`: Tests for network security checks
236
+ - `test_security_services.py`: Tests for AWS security services
237
+
238
+ ### Running Tests
239
+
240
+ The easiest way to run all tests is to use the provided script:
241
+
242
+ ```bash
243
+ # Make the script executable if needed
244
+ chmod +x run_tests.sh
245
+
246
+ # Run the tests
247
+ ./run_tests.sh
248
+ ```
249
+
250
+ This script will:
251
+ 1. Install required dependencies (pytest, pytest-asyncio, pytest-cov)
252
+ 2. Run all tests with coverage reporting
253
+
254
+ For more detailed information about testing, see the tests/README.md file in the project repository.
255
+
256
+ ## License
257
+
258
+ This project is licensed under the Apache License, Version 2.0.
@@ -0,0 +1,13 @@
1
+ awslabs/well_architected_security_mcp_server/__init__.py,sha256=Z4SlKwfbbztnNArU8eALgWVvmOoJE435bvs3frFofRM,711
2
+ awslabs/well_architected_security_mcp_server/consts.py,sha256=yb2hqLTIGJ-zINMUJBZL9nnBk-TWnq4zgLBWZCxrYsE,4638
3
+ awslabs/well_architected_security_mcp_server/server.py,sha256=3qIFQumpLfg6XLxCOYM-brULogeHSbRQz7Gtrfp-KQk,46817
4
+ awslabs/well_architected_security_mcp_server/util/__init__.py,sha256=sr5oDQeipa4mqcJRxmbmLk5qGFISd1nKyPid7ILaWyo,1352
5
+ awslabs/well_architected_security_mcp_server/util/network_security.py,sha256=mYOKWqjnAqioJi0SnSYbNGlw3KrdGbq0cj5cGs73NGw,50665
6
+ awslabs/well_architected_security_mcp_server/util/prompt_utils.py,sha256=6vpSNHmxivwV16LpjeY8mLKVYbxBmC0Z9GJWYui-O4E,5294
7
+ awslabs/well_architected_security_mcp_server/util/resource_utils.py,sha256=o-Y0eGw3DPjGzi_VB8JWKwsiQ_jJ0ZwrCB7G_J78KbI,4282
8
+ awslabs/well_architected_security_mcp_server/util/security_services.py,sha256=8mlThAB5T_Aoa2o3Ft9fqDYudyvk7mYx90UuqHLFhjQ,63619
9
+ awslabs/well_architected_security_mcp_server/util/storage_security.py,sha256=KR2MK31SsU9exKQXfOxAyAShUN1W84stZvec9nZ4L4c,46999
10
+ awslabs_well_architected_security_mcp_server-0.1.1.dist-info/METADATA,sha256=7yNMecCQ9zF3vQy2M3Cw2Im2LdR_PXEgckA4Q33wbqQ,13254
11
+ awslabs_well_architected_security_mcp_server-0.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
12
+ awslabs_well_architected_security_mcp_server-0.1.1.dist-info/entry_points.txt,sha256=_xiSKRnYynbKVQ6Ax2cb-ISPoNqiyqJXSw8b1giWDA8,224
13
+ awslabs_well_architected_security_mcp_server-0.1.1.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.27.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,5 @@
1
+ [console_scripts]
2
+ awslabs.well-architected-security-mcp-server = awslabs.well_architected_security_mcp_server.server:main
3
+
4
+ [mcp]
5
+ well-architected-security-mcp-server = awslabs.well_architected_security_mcp_server.server:mcp