awslabs.terraform-mcp-server 0.0.2__py3-none-any.whl → 0.0.6__py3-none-any.whl

{awslabs_terraform_mcp_server-0.0.2.dist-info → awslabs_terraform_mcp_server-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awslabs.terraform-mcp-server
-Version: 0.0.2
+Version: 0.0.6
 Summary: An AWS Labs Model Context Protocol (MCP) server for terraform
 Requires-Python: >=3.10
 Requires-Dist: beautifulsoup4>=4.12.0

{awslabs_terraform_mcp_server-0.0.2.dist-info → awslabs_terraform_mcp_server-0.0.6.dist-info}/RECORD

@@ -22,11 +22,7 @@ awslabs/terraform_mcp_server/static/AWS_TERRAFORM_BEST_PRACTICES.md,sha256=cftJ9
 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.2.dist-info/METADATA,sha256=wNYoFnJY-jLzLtJuCwGHQ8kxrIUC9uEp8D4BvYWxQiY,4344
-awslabs_terraform_mcp_server-0.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-awslabs_terraform_mcp_server-0.0.2.dist-info/entry_points.txt,sha256=jCTPQeUJ74jpIDcYwVHQCk-y0n0ehRFFerh_Qm4ZU1c,90
-awslabs_terraform_mcp_server-0.0.2.dist-info/RECORD,,
+awslabs_terraform_mcp_server-0.0.6.dist-info/METADATA,sha256=bzMibDYrJ7WJw5duVCwOlTSJyHs5ow_CvJ0OZC-nE8g,4344
+awslabs_terraform_mcp_server-0.0.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+awslabs_terraform_mcp_server-0.0.6.dist-info/entry_points.txt,sha256=jCTPQeUJ74jpIDcYwVHQCk-y0n0ehRFFerh_Qm4ZU1c,90
+awslabs_terraform_mcp_server-0.0.6.dist-info/RECORD,,

awslabs/terraform_mcp_server/tests/__init__.py

@@ -1 +0,0 @@
-"""Test package for terraform_mcp_server."""

awslabs/terraform_mcp_server/tests/run_tests.sh

@@ -1,35 +0,0 @@
-#!/bin/bash
-# Script to run the Terraform MCP server tests
-
-SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
-PROJECT_ROOT="$SCRIPT_DIR/../../.."
-
-# Set PYTHONPATH to include the project root
-export PYTHONPATH="$PROJECT_ROOT:$PYTHONPATH"
-
-# Function to run a test module
-run_test() {
-    echo "Running $1..."
-    cd "$PROJECT_ROOT"
-    python -m awslabs.terraform_mcp_server.tests.$1
-    echo "Test completed: $1"
-}
-
-# Get the test name from the first argument, default to all tests
-TEST_NAME=$1
-if [ -z "$TEST_NAME" ]; then
-    echo "=== Running All Tests ==="
-    run_test "test_parameter_annotations"
-    run_test "test_tool_implementations"
-elif [ "$TEST_NAME" == "params" ]; then
-    run_test "test_parameter_annotations"
-elif [ "$TEST_NAME" == "tools" ]; then
-    run_test "test_tool_implementations"
-else
-    echo "Unknown test: $TEST_NAME"
-    echo "Usage: $0 [params|tools]"
-    echo "  params - Run parameter annotation tests"
-    echo "  tools  - Run tool implementation tests"
-    echo "  (no args) - Run all tests"
-    exit 1
-fi

awslabs/terraform_mcp_server/tests/test_parameter_annotations.py

@@ -1,207 +0,0 @@
-"""Test script for verifying parameter annotations in MCP tools."""
-
-import json
-import sys
-from awslabs.terraform_mcp_server.server import mcp
-from pathlib import Path
-
-
-# Add project root to path to allow importing the server
-project_root = str(Path(__file__).parent.parent.parent.parent)
-if project_root not in sys.path:
-    sys.path.insert(0, project_root)
-
-
-def print_tool_parameters():
-    """Print the parameters for each tool after annotations are added."""
-    tool_names = [
-        'SearchAwsProviderDocs',
-        'ExecuteTerraformCommand',
-        'SearchAwsccProviderDocs',
-        'SearchSpecificAwsIaModules',
-        'RunCheckovScan',
-    ]
-
-    print('\n=== Current Tool Parameter Schemas ===\n')
-    for tool_name in tool_names:
-        try:
-            tool = mcp._tool_manager.get_tool(tool_name)
-            if tool is None:
-                print(f'Tool {tool_name} not found')
-                continue
-
-            if not hasattr(tool, 'parameters') or tool.parameters is None:
-                print(f'Tool {tool_name} has no parameters schema')
-                continue
-
-            print(f'=== {tool_name} Parameters Schema ===')
-            print(json.dumps(tool.parameters, indent=2))
-            print('\n')
-        except Exception as e:
-            print(f'Error getting tool {tool_name}: {e}')
-
-
-def add_parameter_annotations():
-    """Add parameter annotations to the MCP tools."""
-    print('Adding parameter annotations to MCP tools...\n')
-
-    # Add parameter descriptions for SearchAwsProviderDocs
-    search_tool = mcp._tool_manager.get_tool('SearchAwsProviderDocs')
-    if (
-        search_tool is not None
-        and hasattr(search_tool, 'parameters')
-        and search_tool.parameters is not None
-    ):
-        if (
-            'properties' in search_tool.parameters
-            and 'asset_name' in search_tool.parameters['properties']
-        ):
-            search_tool.parameters['properties']['asset_name']['description'] = (
-                'Name of the AWS service (asset) to look for (e.g., "aws_s3_bucket", "aws_lambda_function")'
-            )
-        if (
-            'properties' in search_tool.parameters
-            and 'asset_type' in search_tool.parameters['properties']
-        ):
-            search_tool.parameters['properties']['asset_type']['description'] = (
-                "Type of documentation to search - 'resource', 'data_source', or 'both' (default)"
-            )
-
-    # Add parameter descriptions for SearchAwsccProviderDocs
-    awscc_docs_tool = mcp._tool_manager.get_tool('SearchAwsccProviderDocs')
-    if (
-        awscc_docs_tool is not None
-        and hasattr(awscc_docs_tool, 'parameters')
-        and awscc_docs_tool.parameters is not None
-    ):
-        if (
-            'properties' in awscc_docs_tool.parameters
-            and 'asset_name' in awscc_docs_tool.parameters['properties']
-        ):
-            awscc_docs_tool.parameters['properties']['asset_name']['description'] = (
-                'Name of the AWSCC service (asset) to look for (e.g., awscc_s3_bucket, awscc_lambda_function)'
-            )
-        if (
-            'properties' in awscc_docs_tool.parameters
-            and 'asset_type' in awscc_docs_tool.parameters['properties']
-        ):
-            awscc_docs_tool.parameters['properties']['asset_type']['description'] = (
-                "Type of documentation to search - 'resource', 'data_source', or 'both' (default)"
-            )
-
-    # Add parameter descriptions for SearchSpecificAwsIaModules
-    modules_tool = mcp._tool_manager.get_tool('SearchSpecificAwsIaModules')
-    if (
-        modules_tool is not None
-        and hasattr(modules_tool, 'parameters')
-        and modules_tool.parameters is not None
-    ):
-        if (
-            'properties' in modules_tool.parameters
-            and 'query' in modules_tool.parameters['properties']
-        ):
-            modules_tool.parameters['properties']['query']['description'] = (
-                'Optional search term to filter modules (empty returns all four modules)'
-            )
-
-    # Add parameter descriptions for ExecuteTerraformCommand
-    terraform_tool = mcp._tool_manager.get_tool('ExecuteTerraformCommand')
-    if (
-        terraform_tool is not None
-        and hasattr(terraform_tool, 'parameters')
-        and terraform_tool.parameters is not None
-    ):
-        if (
-            'properties' in terraform_tool.parameters
-            and 'request' in terraform_tool.parameters['properties']
-        ):
-            terraform_tool.parameters['properties']['request']['description'] = (
-                'Details about the Terraform command to execute'
-            )
-
-            # Since request is a complex object with nested properties, update its schema
-            if (
-                'properties' in terraform_tool.parameters['properties']['request']
-                and 'properties'
-                in terraform_tool.parameters['properties']['request']['properties']
-            ):
-                props = terraform_tool.parameters['properties']['request']['properties']
-                if 'command' in props:
-                    props['command']['description'] = (
-                        'Terraform command to execute (init, plan, validate, apply, destroy)'
-                    )
-                if 'working_directory' in props:
-                    props['working_directory']['description'] = (
-                        'Directory containing Terraform files'
-                    )
-                if 'variables' in props:
-                    props['variables']['description'] = 'Terraform variables to pass'
-                if 'aws_region' in props:
-                    props['aws_region']['description'] = 'AWS region to use'
-                if 'strip_ansi' in props:
-                    props['strip_ansi']['description'] = (
-                        'Whether to strip ANSI color codes from output'
-                    )
-
-    # Add parameter descriptions for RunCheckovScan
-    checkov_scan_tool = mcp._tool_manager.get_tool('RunCheckovScan')
-    if (
-        checkov_scan_tool is not None
-        and hasattr(checkov_scan_tool, 'parameters')
-        and checkov_scan_tool.parameters is not None
-    ):
-        if (
-            'properties' in checkov_scan_tool.parameters
-            and 'request' in checkov_scan_tool.parameters['properties']
-        ):
-            checkov_scan_tool.parameters['properties']['request']['description'] = (
-                'Details about the Checkov scan to execute'
-            )
-
-            # Since request is a complex object with nested properties, update its schema
-            if (
-                'properties' in checkov_scan_tool.parameters['properties']['request']
-                and 'properties'
-                in checkov_scan_tool.parameters['properties']['request']['properties']
-            ):
-                props = checkov_scan_tool.parameters['properties']['request']['properties']
-                if 'working_directory' in props:
-                    props['working_directory']['description'] = (
-                        'Directory containing Terraform files to scan'
-                    )
-                if 'framework' in props:
-                    props['framework']['description'] = (
-                        'Framework to scan (terraform, cloudformation, etc.)'
-                    )
-                if 'check_ids' in props:
-                    props['check_ids']['description'] = (
-                        'Optional list of specific check IDs to run'
-                    )
-                if 'skip_check_ids' in props:
-                    props['skip_check_ids']['description'] = 'Optional list of check IDs to skip'
-                if 'output_format' in props:
-                    props['output_format']['description'] = (
-                        'Format for scan results (default: json)'
-                    )
-
-    print('Parameter annotations added successfully.\n')
-
-
-def main():
-    """Run the parameter annotation test."""
-    print('=== Terraform MCP Parameter Annotation Test ===\n')
-
-    # Print original parameter schemas
-    print('Original parameter schemas:')
-    print_tool_parameters()
-
-    # Add parameter annotations
-    add_parameter_annotations()
-
-    # Print updated parameter schemas
-    print('Updated parameter schemas:')
-    print_tool_parameters()
-
-
-if __name__ == '__main__':
-    main()

awslabs/terraform_mcp_server/tests/test_tool_implementations.py

@@ -1,309 +0,0 @@
-"""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())