awslabs.terraform-mcp-server 0.0.1__py3-none-any.whl

awslabs/terraform_mcp_server/tests/test_tool_implementations.py

@@ -0,0 +1,309 @@
+"""Test script for Terraform MCP server implementation functions."""
+
+import asyncio
+import json
+import sys
+from awslabs.terraform_mcp_server.impl.tools.search_aws_provider_docs import (
+    search_aws_provider_docs_impl,
+)
+from awslabs.terraform_mcp_server.impl.tools.search_awscc_provider_docs import (
+    search_awscc_provider_docs_impl,
+)
+from awslabs.terraform_mcp_server.impl.tools.search_specific_aws_ia_modules import (
+    search_specific_aws_ia_modules_impl,
+)
+from loguru import logger
+from typing import Any
+
+
+# Configure logger for enhanced diagnostics with stacktraces
+logger.configure(
+    handlers=[
+        {
+            'sink': sys.stderr,
+            'backtrace': True,
+            'diagnose': True,
+            'format': '<green>{time:YYYY-MM-DD HH:mm:ss.SSS}</green> | <level>{level: <8}</level> | <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>',
+        }
+    ]
+)
+
+
+def print_aws_provider_results(results):
+    """Print formatted results data using the provided logger.
+
+    Args:
+        results: List of result objects containing asset information
+        logger: Logger object to use for output
+    """
+    logger.info(f'Found {len(results)} results')
+
+    for i, result in enumerate(results):
+        logger.info(f'\nResult {i + 1}:')
+        logger.info(f'  Asset Name: {result.asset_name}')
+        logger.info(f'  Asset Type: {result.asset_type}')
+        logger.info(f'  URL: {result.url}')
+
+        # Handle description
+        if result.description:
+            description_preview = (
+                result.description[:50] + '...'
+                if len(result.description) > 50
+                else result.description
+            )
+            logger.info(f'  Description: {description_preview}')
+        else:
+            logger.info('  No description')
+
+        # Handle example usage
+        if result.example_usage:
+            logger.info(f'  Example Usage: {len(result.example_usage)} found')
+
+        # Handle arguments
+        if result.arguments:
+            logger.info(f'  Arguments: {len(result.arguments)} found')
+
+        # Handle attributes
+        if result.attributes:
+            logger.info(f'  Attributes: {len(result.attributes)} found')
+
+
+def print_awscc_provider_results(results):
+    """Print formatted results data using the provided logger.
+
+    Args:
+        results: List of result objects containing asset information
+        logger: Logger object to use for output
+    """
+    logger.info(f'Found {len(results)} results')
+
+    for i, result in enumerate(results):
+        logger.info(f'\nResult {i + 1}:')
+        logger.info(f'  Asset Name: {result.asset_name}')
+        logger.info(f'  Asset Type: {result.asset_type}')
+        logger.info(f'  URL: {result.url}')
+
+        # Handle description
+        if result.description:
+            description_preview = (
+                result.description[:50] + '...'
+                if len(result.description) > 50
+                else result.description
+            )
+            logger.info(f'  Description: {description_preview}')
+        else:
+            logger.info('  No description')
+
+        # Handle example usage
+        if result.example_usage:
+            logger.info(f'  Example Usage: {len(result.example_usage)} found')
+
+        # Handle schema arguments
+        if result.schema_arguments:
+            logger.info(f'  Schema arguments: {len(result.schema_arguments)} found')
+
+
+async def test_search_aws_provider_docs():
+    """Test the AWS provider docs search function."""
+    logger.info('=== Testing search_aws_provider_docs_impl ===')
+
+    # Test case 1: Common resource with just 1 example snippet
+    logger.info('**********---Test case 1: Searching for aws_s3_bucket as a resource---**********')
+    results = await search_aws_provider_docs_impl('aws_s3_bucket', 'resource')
+    print_aws_provider_results(results)
+
+    # Test case 2: Common resource with multiple example snippets
+    logger.info(
+        '**********---Test case 2: Searching for aws_api_gateway_rest_api as a resource---**********'
+    )
+    results = await search_aws_provider_docs_impl('api_gateway_rest_api', 'resource')
+    print_aws_provider_results(results)
+
+    # Test case 3: Common resource with multiple example snippets and multiple arguments in subsections
+    logger.info(
+        '**********---Test case 3: Searching for aws_lambda_function as a resource---**********'
+    )
+    results = await search_aws_provider_docs_impl('aws_lambda_function', 'resource')
+    print_aws_provider_results(results)
+
+    # Test case 4: Specifying data source as asset type
+    logger.info(
+        '**********---Test case 4: Searching for aws_lambda_function as a data source ---**********'
+    )
+    results = await search_aws_provider_docs_impl('aws_lambda_function', 'data_source')
+    print_aws_provider_results(results)
+
+    # Test case 5: Searching for both kinds
+    logger.info('**********---Test case 5: Searching for aws_dynamodb_table as both ---**********')
+    results = await search_aws_provider_docs_impl('aws_dynamodb_table', 'both')
+    print_aws_provider_results(results)
+
+    # Test case 6: Non-existent resource
+    logger.info('**********---Test case 6: Searching for non-existent resource---**********')
+    results = await search_aws_provider_docs_impl('aws_nonexistent_resource')
+    print_aws_provider_results(results)
+
+
+async def test_search_awscc_provider_docs():
+    """Test the AWSCC provider docs search function."""
+    logger.info('\n=== Testing search_awscc_provider_docs_impl ===')
+
+    # Test case 1: Common resource
+    logger.info(
+        '**********---Test case 1: Searching for awscc_apigateway_api_key as a resource---**********'
+    )
+    results = await search_awscc_provider_docs_impl('awscc_apigateway_api_key', 'resource')
+    print_awscc_provider_results(results)
+
+    # Test case 2: Resource with attribute
+    logger.info(
+        '**********---Test case 2: Searching for awscc_apigateway_api_key as a data source---**********'
+    )
+    results = await search_awscc_provider_docs_impl('awscc_apigateway_api_key', 'data_source')
+    print_awscc_provider_results(results)
+
+    # Test case 3: lambda_function resource
+    logger.info(
+        '**********---Test case 7: Searching for lambda_function as a resource---**********'
+    )
+    results = await search_awscc_provider_docs_impl('lambda_function', 'resource')
+    print_awscc_provider_results(results)
+
+    # Test case 4: Searching for both kinds
+    logger.info(
+        '**********---Test case 4: Searching for lambda_function as both kinds---**********'
+    )
+    results = await search_awscc_provider_docs_impl('awscc_lambda_function', 'both')
+    print_awscc_provider_results(results)
+
+    # Test case 5: Non-existent resource
+    logger.info('**********---Test case 5: Searching for non-existent resource---**********')
+    results = await search_awscc_provider_docs_impl('awscc_nonexistent_resource')
+    print_awscc_provider_results(results)
+
+
+async def test_search_specific_aws_ia_modules():
+    """Test the AWS IA modules search function."""
+    logger.info('\n=== Testing search_specific_aws_ia_modules_impl ===')
+
+    # Test case 1: Search all modules
+    logger.info('Test case 1: Searching all AWS IA modules')
+    results = await search_specific_aws_ia_modules_impl('')
+
+    logger.info(f'Found {len(results)} modules')
+    for i, result in enumerate(results):
+        logger.info(f'\nModule {i + 1}:')
+        logger.info(f'  Name: {result.name}')
+        logger.info(f'  Namespace: {result.namespace}')
+        logger.info(
+            f'  Description: {result.description[:100]}...'
+            if result.description
+            else '  No description'
+        )
+        logger.info(f'  URL: {result.url}')
+
+    # Test case 2: Search with query
+    logger.info("\nTest case 2: Searching for 'bedrock' modules")
+    results = await search_specific_aws_ia_modules_impl('bedrock')
+
+    logger.info(f'Found {len(results)} modules')
+    for i, result in enumerate(results):
+        logger.info(f'\nModule {i + 1}:')
+        logger.info(f'  Name: {result.name}')
+        logger.info(f'  Namespace: {result.namespace}')
+        logger.info(
+            f'  Description: {result.description[:100]}...'
+            if result.description
+            else '  No description'
+        )
+
+
+async def test_execute_terraform_command():
+    """Test the Terraform command execution function.
+
+    Note: This test requires a valid Terraform configuration in a temporary directory.
+    Skip this test if you don't have a valid Terraform configuration to test with.
+    """
+    logger.info('\n=== Testing execute_terraform_command_impl ===')
+    logger.info('Skipping actual execution as it requires a valid Terraform configuration.')
+    logger.info('To test this function, you would need to:')
+    logger.info('1. Create a temporary directory with valid Terraform files')
+    logger.info('2. Run terraform init, plan, etc. on those files')
+
+    # Example of how you would call it (commented out)
+    """
+    request = TerraformExecutionRequest(
+        command="validate",
+        working_directory="/path/to/terraform/config",
+        variables={"environment": "test"},
+        aws_region="us-west-2",
+        strip_ansi=True
+    )
+
+    result = await execute_terraform_command_impl(request)
+    logger.info(f"Command: {result.command}")
+    logger.info(f"Status: {result.status}")
+    logger.info(f"Return Code: {result.return_code}")
+    if result.stdout:
+        logger.info(f"Stdout: {result.stdout[:100]}...")
+    if result.stderr:
+        logger.info(f"Stderr: {result.stderr[:100]}...")
+    """
+
+
+async def test_run_checkov_scan():
+    """Test the Checkov scan function.
+
+    Note: This test requires a valid Terraform configuration in a temporary directory.
+    Skip this test if you don't have a valid Terraform configuration to test with.
+    """
+    logger.info('\n=== Testing run_checkov_scan_impl ===')
+    logger.info('Skipping actual execution as it requires a valid Terraform configuration.')
+    logger.info('To test this function, you would need to:')
+    logger.info('1. Create a temporary directory with valid Terraform files')
+    logger.info('2. Run Checkov on those files')
+
+    # Example of how you would call it (commented out)
+    """
+    request = CheckovScanRequest(
+        working_directory="/path/to/terraform/config",
+        framework="terraform",
+        output_format="json"
+    )
+
+    result = await run_checkov_scan_impl(request)
+    logger.info(f"Status: {result.status}")
+    logger.info(f"Return Code: {result.return_code}")
+    logger.info(f"Found {len(result.vulnerabilities)} vulnerabilities")
+    for i, vuln in enumerate(result.vulnerabilities[:3]):  # Show first 3 only
+        logger.info(f"\nVulnerability {i+1}:")
+        logger.info(f"  ID: {vuln.id}")
+        logger.info(f"  Resource: {vuln.resource}")
+        logger.info(f"  Description: {vuln.description[:100]}..." if vuln.description else "  No description")
+    """
+
+
+def format_json(obj: Any) -> str:
+    """Format an object as pretty JSON."""
+    if hasattr(obj, 'model_dump'):
+        # For Pydantic v2
+        data = obj.model_dump()
+    elif hasattr(obj, 'dict'):
+        # For Pydantic v1
+        data = obj.dict()
+    else:
+        data = obj
+    return json.dumps(data, indent=2, default=str)
+
+
+async def main():
+    """Run all tests."""
+    try:
+        await test_search_aws_provider_docs()
+        await test_search_awscc_provider_docs()
+    except Exception as e:
+        logger.exception(f'Error running tests: {e}')
+
+
+if __name__ == '__main__':
+    asyncio.run(main())

awslabs_terraform_mcp_server-0.0.1.dist-info/METADATA

@@ -0,0 +1,97 @@
+Metadata-Version: 2.4
+Name: awslabs.terraform-mcp-server
+Version: 0.0.1
+Summary: An AWS Labs Model Context Protocol (MCP) server for terraform
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: checkov>=3.2.402
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: mcp[cli]>=1.6.0
+Requires-Dist: playwright>=1.40.0
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pypdf2>=3.0.0
+Requires-Dist: requests>=2.31.0
+Description-Content-Type: text/markdown
+
+# AWS Terraform MCP Server
+
+MCP server for Terraform on AWS best practices, infrastructure as code patterns, and security compliance with Checkov.
+
+## Features
+
+- **Terraform Best Practices** - Get prescriptive Terraform advice for building applications on AWS
+  - AWS Well-Architected guidance for Terraform configurations
+  - Security and compliance recommendations
+  - AWSCC provider prioritization for consistent API behavior
+
+- **Security-First Development Workflow** - Follow a structured process for creating secure code
+  - Step-by-step guidance for validation and security scanning
+  - Integration of Checkov at the right stages of development
+  - Clear handoff points between AI assistance and developer deployment
+
+- **Checkov Integration** - Work with Checkov for security and compliance scanning
+  - Run security scans on Terraform code to identify vulnerabilities
+  - Automatically fix identified security issues when possible
+  - Get detailed remediation guidance for compliance issues
+
+- **AWS Provider Documentation** - Search for AWS and AWSCC provider resources
+  - Find documentation for specific resources and attributes
+  - Get example snippets and implementation guidance
+  - Compare AWS and AWSCC provider capabilities
+
+- **AWS-IA GenAI Modules** - Access specialized modules for AI/ML workloads
+  - Amazon Bedrock module for generative AI applications
+  - OpenSearch Serverless for vector search capabilities
+  - SageMaker endpoint deployment for ML model hosting
+  - Serverless Streamlit application deployment for AI interfaces
+
+- **Terraform Workflow Execution** - Run Terraform commands directly
+  - Initialize, plan, validate, apply, and destroy operations
+  - Pass variables and specify AWS regions
+  - Get formatted command output for analysis
+
+## Tools and Resources
+
+- **Terraform Development Workflow**: Follow security-focused development process via `terraform://workflow_guide`
+- **AWS Best Practices**: Access AWS-specific guidance via `terraform://aws_best_practices`
+- **AWS Provider Resources**: Access resource listings via `terraform://aws_provider_resources_listing`
+- **AWSCC Provider Resources**: Access resource listings via `terraform://awscc_provider_resources_listing`
+
+## Prerequisites
+
+1. Install `uv` from [Astral](https://docs.astral.sh/uv/getting-started/installation/) or the [GitHub README](https://github.com/astral-sh/uv#installation)
+2. Install Python using `uv python install 3.10`
+3. Install Terraform CLI for workflow execution
+4. Install Checkov for security scanning
+
+## Installation
+
+Here are some ways you can work with MCP across AWS, and we'll be adding support to more products including Amazon Q Developer CLI soon: (e.g. for Amazon Q Developer CLI MCP, `~/.aws/amazonq/mcp.json`):
+
+```json
+{
+  "mcpServers": {
+    "awslabs.terraform-mcp-server": {
+      "command": "uvx",
+      "args": ["awslabs.terraform-mcp-server@latest"],
+      "env": {
+        "FASTMCP_LOG_LEVEL": "ERROR"
+      },
+      "disabled": false,
+      "autoApprove": []
+    }
+  }
+}
+```
+
+## Security Considerations
+
+When using this MCP server, you should consider:
+- **Following the structured development workflow** that integrates validation and security scanning
+- Reviewing all Checkov warnings and errors manually
+- Fixing security issues rather than ignoring them whenever possible
+- Documenting clear justifications for any necessary exceptions
+- Using the RunCheckovScan tool regularly to verify security compliance
+- Preferring the AWSCC provider for its consistent API behavior and better security defaults
+
+Before applying Terraform changes to production environments, you should conduct your own independent assessment to ensure that your infrastructure would comply with your own specific security and quality control practices and standards, as well as the local laws, rules, and regulations that govern you and your content.

awslabs_terraform_mcp_server-0.0.1.dist-info/RECORD

@@ -0,0 +1,32 @@
+awslabs/__init__.py,sha256=4zfFn3N0BkvQmMTAIvV_QAbKp6GWzrwaUN17YeRoChM,115
+awslabs/terraform_mcp_server/__init__.py,sha256=a-zIkwClerA84_XGykBggO4w5kf8f85EapnWnbAH01c,58
+awslabs/terraform_mcp_server/server.py,sha256=3N5A5eP6YB0YqCw6nbekzpXctd724rgtu--6zqvFlfA,13626
+awslabs/terraform_mcp_server/impl/resources/__init__.py,sha256=bxqHGDtuwWq8w-21lT5GzOuxBqkmnUvW6cnSA36ve3A,388
+awslabs/terraform_mcp_server/impl/resources/terraform_aws_provider_resources_listing.py,sha256=t_guGQ44yvip9u2cONN2cWc3fXk6HyQGPu5DDP5YEkI,1973
+awslabs/terraform_mcp_server/impl/resources/terraform_awscc_provider_resources_listing.py,sha256=RoBSe-p5OyLYWNYa7aGx2f4NWyjap1wNrj8F4o8_PSo,2060
+awslabs/terraform_mcp_server/impl/tools/__init__.py,sha256=TRlf5cGGVKfofMGwX_T8YXvnq8Evcyl0AzabiwIZyFc,601
+awslabs/terraform_mcp_server/impl/tools/execute_terraform_command.py,sha256=_fPxC2wT23oWa9XaAoUEV1j5lK7Xpi7MqBAq85fLNdU,8507
+awslabs/terraform_mcp_server/impl/tools/run_checkov_scan.py,sha256=oS6qgUPPti7lpa2VNsUwPbswiq2hgpe49fggVUI_PfM,13435
+awslabs/terraform_mcp_server/impl/tools/search_aws_provider_docs.py,sha256=w7NX4oQwsCeVQPj8YZzvXvXcox8drzZimW3mRL8Kd84,29049
+awslabs/terraform_mcp_server/impl/tools/search_awscc_provider_docs.py,sha256=fY8eRQ1j6oB4XyfAoUC6mTUXNkoFaY0vsmMhV6w0NR8,27297
+awslabs/terraform_mcp_server/impl/tools/search_specific_aws_ia_modules.py,sha256=Kny5iharA1Wj-9tnhoPHntu4qM9n-2mC2dB6TXwhqfk,20148
+awslabs/terraform_mcp_server/impl/tools/utils.py,sha256=GB1OuhYgrg00AzKfhgaUpQwbVBK5D56GQLcm60NHd1c,20500
+awslabs/terraform_mcp_server/models/__init__.py,sha256=L7nlJJ9g_J7tuYw_BD_XarEcwH3WonrIoOBZcD5FC7A,651
+awslabs/terraform_mcp_server/models/models.py,sha256=ZVn0gFlqjYTD0mNvlvXTilNhk2o9Mse9oUEBbl38Cbo,10685
+awslabs/terraform_mcp_server/scripts/generate_aws_provider_resources.py,sha256=v8t4UL8KwIoqVYz25Xd8wiJJ2cwKmHvxaF0_ZpUI0b4,56714
+awslabs/terraform_mcp_server/scripts/generate_awscc_provider_resources.py,sha256=FN2QOYefeEcyy-JXl1v3hLEz2YSBNRJB_9i182DdWiA,48722
+awslabs/terraform_mcp_server/scripts/scrape_aws_terraform_best_practices.py,sha256=t_eFbciBwZXdK6pNkkcp4X7VPR4vXyXkmE_YLhm6Xr4,3783
+awslabs/terraform_mcp_server/static/AWSCC_PROVIDER_RESOURCES.md,sha256=I_vu3dWXzd9Pxcd7tkdxFQs97wtuunyoXdJCAkCUXnE,440270
+awslabs/terraform_mcp_server/static/AWS_PROVIDER_RESOURCES.md,sha256=OMboscC0Ov6O3U3K1uqrzRzx18nq_5AsJzITc5-CA8Y,303030
+awslabs/terraform_mcp_server/static/AWS_TERRAFORM_BEST_PRACTICES.md,sha256=cftJ9y2nZ0kMendoV6WBlQFsNw-QnGnmF6dR88eoYdA,87665
+awslabs/terraform_mcp_server/static/MCP_INSTRUCTIONS.md,sha256=k6XQFgab3_W7_g0AZNXdyxyrzA2RjOzP9DbXS_9FiP4,6010
+awslabs/terraform_mcp_server/static/TERRAFORM_WORKFLOW_GUIDE.md,sha256=qvqtaikyyQ_XHL-LyU_BDos1ym2kKBR7ljMZtLn3FAs,9322
+awslabs/terraform_mcp_server/static/__init__.py,sha256=J5JGKYybg48XyBi2hepC101RDNFBxSXZS5YGvj0tql8,549
+awslabs/terraform_mcp_server/tests/__init__.py,sha256=eWyaXCIPzCC8_4kXuKnK9s79gg6_J3XYoAtQzkNesWI,45
+awslabs/terraform_mcp_server/tests/run_tests.sh,sha256=u6GUSQffYJyn0RkAd4qeqkczYc_cf-lL3kC4a1YYjB4,1068
+awslabs/terraform_mcp_server/tests/test_parameter_annotations.py,sha256=7DrC-idSQmrSAAPLHQ09V3sU7a_8HkfCrOnqJn2SQeo,8361
+awslabs/terraform_mcp_server/tests/test_tool_implementations.py,sha256=Uh8vyFJJ9ti14hkmQDkWJEtGUJvFR3IZ0P90ez0LiMY,11641
+awslabs_terraform_mcp_server-0.0.1.dist-info/METADATA,sha256=nDWAkf29xw-lxh4eUuLBSW6QiFHd4f7hgkHwaw8xr8w,4344
+awslabs_terraform_mcp_server-0.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+awslabs_terraform_mcp_server-0.0.1.dist-info/entry_points.txt,sha256=jCTPQeUJ74jpIDcYwVHQCk-y0n0ehRFFerh_Qm4ZU1c,90
+awslabs_terraform_mcp_server-0.0.1.dist-info/RECORD,,

awslabs_terraform_mcp_server-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

awslabs_terraform_mcp_server-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+awslabs.terraform-mcp-server = awslabs.terraform_mcp_server.server:main