awslabs.cfn-mcp-server 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

awslabs/cfn_mcp_server/aws_client.py

@@ -9,6 +9,7 @@
 # OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
 # and limitations under the License.
 
+import botocore.config
 import sys
 from awslabs.cfn_mcp_server.errors import ClientError
 from boto3 import Session
@@ -16,6 +17,9 @@ from os import environ
 
 
 session = Session(profile_name=environ.get('AWS_PROFILE'))
+session_config = botocore.config.Config(
+    user_agent_extra='cfn-mcp-server/1.0.0',
+)
 
 
 def get_aws_client(service_name, region_name=None):
@@ -47,7 +51,7 @@ def get_aws_client(service_name, region_name=None):
         print(
             f'Creating new {service_name} client for region {region_name} with auto-detected credentials'
         )
-        client = session.client(service_name, region_name=region_name)
+        client = session.client(service_name, region_name=region_name, config=session_config)
 
         print('Created client for service with credentials')
         return client

awslabs/cfn_mcp_server/errors.py

@@ -86,6 +86,6 @@ class ServerError(Exception):
     def __init__(self, log):
         """Call super."""
         # Call the base class constructor with the parameters it needs
-        super().__init__('An internal error occured while processing your request')
+        super().__init__('An internal error occurred while processing your request')
         print(log)
         self.type = 'server'

awslabs/cfn_mcp_server/iac_generator.py

@@ -0,0 +1,200 @@
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
+# with the License. A copy of the License is located at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
+# OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
+# and limitations under the License.
+
+"""CloudFormation IaC Generator tool implementation."""
+
+import os
+from awslabs.cfn_mcp_server.aws_client import get_aws_client
+from awslabs.cfn_mcp_server.errors import ClientError, handle_aws_api_error
+from typing import Dict, List, Optional
+
+
+async def create_template(
+    template_name: Optional[str] = None,
+    resources: Optional[List[Dict[str, str]]] = None,
+    output_format: str = 'YAML',
+    deletion_policy: str = 'RETAIN',
+    update_replace_policy: str = 'RETAIN',
+    template_id: Optional[str] = None,
+    save_to_file: Optional[str] = None,
+    region_name: Optional[str] = None,
+) -> Dict:
+    """Create a CloudFormation template from existing resources using the IaC Generator API.
+
+    This function handles three main scenarios:
+    1. Starting a new template generation process
+    2. Checking the status of an existing template generation process
+    3. Retrieving a generated template
+
+    Args:
+        template_name: Name for the generated template
+        resources: List of resources to include in the template, each with 'ResourceType' and 'ResourceIdentifier'
+        output_format: Output format for the template (JSON or YAML)
+        deletion_policy: Default DeletionPolicy for resources in the template (RETAIN, DELETE, or SNAPSHOT)
+        update_replace_policy: Default UpdateReplacePolicy for resources in the template (RETAIN, DELETE, or SNAPSHOT)
+        template_id: ID of an existing template generation process to check status or retrieve template
+        save_to_file: Path to save the generated template to a file
+        region_name: AWS region name
+
+    Returns:
+        A dictionary containing information about the template generation process or the generated template
+    """
+    # Validate parameters
+    if not template_id and not template_name:
+        raise ClientError('Either template_name or template_id must be provided')
+
+    if output_format not in ['JSON', 'YAML']:
+        raise ClientError("output_format must be either 'JSON' or 'YAML'")
+
+    if deletion_policy not in ['RETAIN', 'DELETE', 'SNAPSHOT']:
+        raise ClientError("deletion_policy must be one of 'RETAIN', 'DELETE', or 'SNAPSHOT'")
+
+    if update_replace_policy not in ['RETAIN', 'DELETE', 'SNAPSHOT']:
+        raise ClientError("update_replace_policy must be one of 'RETAIN', 'DELETE', or 'SNAPSHOT'")
+
+    # Get CloudFormation client
+    cfn_client = get_aws_client('cloudformation', region_name)
+
+    # Case 1: Check status or retrieve template for an existing template generation process
+    if template_id:
+        return await _handle_existing_template(
+            cfn_client, template_id, save_to_file, output_format
+        )
+
+    # Case 2: Start a new template generation process
+    return await _start_template_generation(
+        cfn_client, template_name, resources, deletion_policy, update_replace_policy
+    )
+
+
+async def _start_template_generation(
+    cfn_client,
+    template_name: str | None,
+    resources: Optional[List[Dict[str, str]]],
+    deletion_policy: str,
+    update_replace_policy: str,
+) -> Dict:
+    """Start a new template generation process.
+
+    Args:
+        cfn_client: Boto3 CloudFormation client
+        template_name: Name for the generated template
+        resources: List of resources to include in the template
+        output_format: Output format for the template (JSON or YAML)
+        deletion_policy: DeletionPolicy for resources in the template
+        update_replace_policy: UpdateReplacePolicy for resources in the template
+
+    Returns:
+        A dictionary containing information about the template generation process
+    """
+    # Prepare parameters for the API call
+    params = {
+        'GeneratedTemplateName': template_name,
+        'TemplateConfiguration': {
+            'DeletionPolicy': deletion_policy,
+            'UpdateReplacePolicy': update_replace_policy,
+        },
+    }
+
+    # Add resources if provided
+    if resources:
+        resource_identifiers = []
+        for resource in resources:
+            if 'ResourceType' not in resource or 'ResourceIdentifier' not in resource:
+                raise ClientError(
+                    "Each resource must have 'ResourceType' and 'ResourceIdentifier'"
+                )
+            resource_identifiers.append(
+                {
+                    'ResourceType': resource['ResourceType'],
+                    'ResourceIdentifier': resource['ResourceIdentifier'],
+                }
+            )
+        params['Resources'] = resource_identifiers
+
+    # Call the API
+    try:
+        response = cfn_client.create_generated_template(**params)
+        return {
+            'status': 'INITIATED',
+            'template_id': response['GeneratedTemplateId'],
+            'message': 'Template generation initiated. Use the template_id to check status.',
+        }
+    except Exception as e:
+        raise handle_aws_api_error(e)
+
+
+async def _handle_existing_template(
+    cfn_client, template_id: str, save_to_file: Optional[str], output_format: str = 'YAML'
+) -> Dict:
+    """Handle an existing template generation process - check status or retrieve template.
+
+    Args:
+        cfn_client: Boto3 CloudFormation client
+        template_id: ID of the template generation process
+        save_to_file: Path to save the generated template to a file
+        output_format: Format of generated template. Either JSON or YAML
+
+    Returns:
+        A dictionary containing information about the template generation process or the generated template
+    """
+    # Check the status of the template generation process
+    try:
+        status_response = cfn_client.describe_generated_template(GeneratedTemplateName=template_id)
+
+        status = status_response['Status']
+
+        # Return status information if the template is not yet complete
+        if status != 'COMPLETE':
+            return {
+                'status': status,
+                'template_id': template_id,
+                'message': f'Template generation {status.lower()}.',
+            }
+
+        # If the template is complete, retrieve it
+        template_response = cfn_client.get_generated_template(
+            GeneratedTemplateName=template_id, Format=output_format
+        )
+
+        template_content = template_response['TemplateBody']
+        resources = status_response.get('ResourceIdentifiers', [])
+
+        # Save the template to a file if requested
+        file_path = None
+        if save_to_file:
+            try:
+                # Ensure the directory exists
+                os.makedirs(os.path.dirname(os.path.abspath(save_to_file)), exist_ok=True)
+
+                # Write the template to the file
+                with open(save_to_file, 'w') as f:
+                    f.write(template_content)
+                file_path = save_to_file
+            except Exception as e:
+                raise ClientError(f'Failed to save template to file: {str(e)}')
+
+        # Return the template and related information
+        result = {
+            'status': 'COMPLETED',
+            'template_id': template_id,
+            'template': template_content,
+            'resources': resources,
+            'message': 'Template generation completed.',
+        }
+
+        if file_path:
+            result['file_path'] = file_path
+
+        return result
+
+    except Exception as e:
+        raise handle_aws_api_error(e)

awslabs/cfn_mcp_server/server.py

@@ -17,6 +17,7 @@ from awslabs.cfn_mcp_server.aws_client import get_aws_client
 from awslabs.cfn_mcp_server.cloud_control_utils import progress_event, validate_patch
 from awslabs.cfn_mcp_server.context import Context
 from awslabs.cfn_mcp_server.errors import ClientError, handle_aws_api_error
+from awslabs.cfn_mcp_server.iac_generator import create_template as create_template_impl
 from awslabs.cfn_mcp_server.schema_manager import schema_manager
 from mcp.server.fastmcp import FastMCP
 from pydantic import Field
@@ -31,11 +32,7 @@ mcp = FastMCP(
     1. Read and List all of your AWS resources by the CloudFormation type name (e.g. AWS::S3::Bucket)
     2. Create/Update/Delete your AWS resources
     """,
-    dependencies=[
-        'pydantic',
-        'loguru',
-        'boto3',
-    ],
+    dependencies=['pydantic', 'loguru', 'boto3', 'botocore'],
 )
 
 
@@ -173,7 +170,7 @@ async def update_resource(
             "identifier": The resource identifier
             "is_complete": Boolean indicating whether the operation is complete
             "status_message": Human-readable message describing the result
-            "request_token": A token that allows you to track long running operations via the get_request_status tool
+            "request_token": A token that allows you to track long running operations via the get_resource_request_status tool
             "resource_info": Optional information about the resource properties
         }
     """
@@ -233,7 +230,7 @@ async def create_resource(
             "identifier": The resource identifier
             "is_complete": Boolean indicating whether the operation is complete
             "status_message": Human-readable message describing the result
-            "request_token": A token that allows you to track long running operations via the get_request_status tool
+            "request_token": A token that allows you to track long running operations via the get_resource_request_status tool
             "resource_info": Optional information about the resource properties
         }
     """
@@ -286,7 +283,7 @@ async def delete_resource(
             "identifier": The resource identifier
             "is_complete": Boolean indicating whether the operation is complete
             "status_message": Human-readable message describing the result
-            "request_token": A token that allows you to track long running operations via the get_request_status tool
+            "request_token": A token that allows you to track long running operations via the get_resource_request_status tool
         }
     """
     if not resource_type:
@@ -312,7 +309,7 @@ async def delete_resource(
 
 
 @mcp.tool()
-async def get_request_status(
+async def get_resource_request_status(
     request_token: str = Field(
         description='The request_token returned from the long running operation'
     ),
@@ -334,7 +331,7 @@ async def get_request_status(
             "identifier": The resource identifier
             "is_complete": Boolean indicating whether the operation is complete
             "status_message": Human-readable message describing the result
-            "request_token": A token that allows you to track long running operations via the get_request_status tool
+            "request_token": A token that allows you to track long running operations via the get_resource_request_status tool
             "error_code": A code associated with any errors if the request failed
             "retry_after": A duration to wait before retrying the request
         }
@@ -353,6 +350,73 @@ async def get_request_status(
     return progress_event(response['ProgressEvent'])
 
 
+@mcp.tool()
+async def create_template(
+    template_name: str | None = Field(None, description='Name for the generated template'),
+    resources: list | None = Field(
+        None,
+        description="List of resources to include in the template, each with 'ResourceType' and 'ResourceIdentifier'",
+    ),
+    output_format: str = Field(
+        'YAML', description='Output format for the template (JSON or YAML)'
+    ),
+    deletion_policy: str = Field(
+        'RETAIN',
+        description='Default DeletionPolicy for resources in the template (RETAIN, DELETE, or SNAPSHOT)',
+    ),
+    update_replace_policy: str = Field(
+        'RETAIN',
+        description='Default UpdateReplacePolicy for resources in the template (RETAIN, DELETE, or SNAPSHOT)',
+    ),
+    template_id: str | None = Field(
+        None,
+        description='ID of an existing template generation process to check status or retrieve template',
+    ),
+    save_to_file: str | None = Field(
+        None, description='Path to save the generated template to a file'
+    ),
+    region: str | None = Field(
+        description='The AWS region that the operation should be performed in', default=None
+    ),
+) -> dict:
+    """Create a CloudFormation template from existing resources using the IaC Generator API.
+
+    This tool allows you to generate CloudFormation templates from existing AWS resources
+    that are not already managed by CloudFormation. The template generation process is
+    asynchronous, so you can check the status of the process and retrieve the template
+    once it's complete. You can pass up to 500 resources at a time.
+
+    Examples:
+    1. Start template generation for an S3 bucket:
+       create_template(
+           template_name="my-template",
+           resources=[{"ResourceType": "AWS::S3::Bucket", "ResourceIdentifier": {"BucketName": "my-bucket"}}],
+           deletion_policy="RETAIN",
+           update_replace_policy="RETAIN"
+       )
+
+    2. Check status of template generation:
+       create_template(template_id="arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/abcdef12-3456-7890-abcd-ef1234567890")
+
+    3. Retrieve and save generated template:
+       create_template(
+           template_id="arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/abcdef12-3456-7890-abcd-ef1234567890",
+           save_to_file="/path/to/template.yaml",
+           output_format="YAML"
+       )
+    """
+    return await create_template_impl(
+        template_name=template_name,
+        resources=resources,
+        output_format=output_format,
+        deletion_policy=deletion_policy,
+        update_replace_policy=update_replace_policy,
+        template_id=template_id,
+        save_to_file=save_to_file,
+        region_name=region,
+    )
+
+
 def main():
     """Run the MCP server with CLI argument support."""
     parser = argparse.ArgumentParser(

{awslabs_cfn_mcp_server-1.0.0.dist-info → awslabs_cfn_mcp_server-1.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: awslabs.cfn-mcp-server
-Version: 1.0.0
+Version: 1.0.2
 Summary: An AWS Labs Model Context Protocol (MCP) server for doing common cloudformation tasks and for managing your resources in your AWS account
 Project-URL: homepage, https://awslabs.github.io/mcp/
 Project-URL: docs, https://awslabs.github.io/mcp/servers/cfn-mcp-server/
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.10
 Requires-Dist: boto3>=1.34.0
+Requires-Dist: botocore>=1.34.0
 Requires-Dist: loguru>=0.7.0
 Requires-Dist: mcp[cli]>=1.6.0
 Requires-Dist: pydantic>=2.10.6
@@ -29,7 +30,7 @@ Description-Content-Type: text/markdown
 
 # CloudFormation MCP Server
 
-Model Context Protocol (MCP) server that enables LLMs to directly create and manage over 1,100 AWS resources through natural language using AWS Cloud Control API with Infrastructure as Code best practices.
+Model Context Protocol (MCP) server that enables LLMs to directly create and manage over 1,100 AWS resources through natural language using AWS Cloud Control API and Iac Generator with Infrastructure as Code best practices.
 
 ## Features
 
@@ -41,6 +42,7 @@ Model Context Protocol (MCP) server that enables LLMs to directly create and man
 - **Schema Information**: Returns detailed CloudFormation schema for any resource to enable more effective operations
 - **Natural Language Interface**: Transform infrastructure-as-code from static authoring to dynamic conversations
 - **Partner Resource Support**: Works with both AWS-native and partner-defined resources
+- **Template Generation**: Generates a template on created/existing resources for a [subset of resource types](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html)
 
 ## Prerequisites
 
@@ -92,10 +94,10 @@ If you would like to prevent the MCP from taking any mutating actions (i.e. Crea
 }
 ```
 
-or docker after a succesful `docker build -t awslabs/cfn-mcp-server .`:
+or docker after a successful `docker build -t awslabs/cfn-mcp-server .`:
 
 ```file
-# ficticious `.env` file with AWS temporary credentials
+# fictitious `.env` file with AWS temporary credentials
 AWS_ACCESS_KEY_ID=ASIAIOSFODNN7EXAMPLE
 AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 AWS_SESSION_TOKEN=AQoEXAMPLEH4aoAH0gNCAPy...truncated...zrkuWJOgQs8IZZaIv2BXIa2R4Olgk
@@ -152,8 +154,12 @@ Get schema information for an AWS CloudFormation resource.
 **Example**: Get the schema for AWS::S3::Bucket to understand all available properties.
 
 ### get_request_status
-Get the status of a mutation that was initiated by create/update/delete resource
-**Example**: Give me the status of the last request I made
+Get the status of a mutation that was initiated by create/update/delete resource.
+**Example**: Give me the status of the last request I made.
+
+### create_tempalte
+Create a Cloudformation template from created or listed resources.
+**Example**: Create a YAML template for those resources.
 
 ## Basic Usage
 
@@ -168,6 +174,7 @@ Examples of how to use the AWS Infrastructure as Code MCP Server:
 - "Configure CloudWatch alarms for all production resources"
 - "Implement cross-region replication for critical S3 buckets"
 - "Show me the schema for AWS::Lambda::Function"
+- "Create a template for all the resources we created and modified"
 
 ## Resource Type support
 Resources which are supported by this MCP and the supported operations can be found here: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/supported-resources.html
@@ -198,7 +205,10 @@ Ensure your AWS credentials have the following minimum permissions:
                 "cloudcontrol:GetResource",
                 "cloudcontrol:CreateResource",
                 "cloudcontrol:DeleteResource",
-                "cloudcontrol:UpdateResource"
+                "cloudcontrol:UpdateResource",
+                "cloudformation:CreateGeneratedTemplate",
+                "cloudformation:DescribeGeneratedTemplate",
+                "cloudformation:GetGeneratedTemplate"
             ],
             "Resource": "*"
         }
@@ -208,10 +218,11 @@ Ensure your AWS credentials have the following minimum permissions:
 
 ## Limitations
 
-- Operations are limited to resources supported by AWS Cloud Control API
+- Operations are limited to resources supported by AWS Cloud Control API and Iac Generator
 - Performance depends on the underlying AWS services' response times
 - Some complex resource relationships may require multiple operations
-- This MCP server can only manage resources in the AWS regions where Cloud Control API is available
+- This MCP server can only manage resources in the AWS regions where Cloud Control API and/or Iac Generator is available
 - Resource modification operations may be limited by service-specific constraints
 - Rate limiting may affect operations when managing many resources simultaneously
 - Some resource types might not support all operations (create, read, update, delete)
+- Generated templates are primarily intended for importing existing resources into a CloudFormation stack and may not always work for creating new resources (in another account or region)

awslabs_cfn_mcp_server-1.0.2.dist-info/RECORD

@@ -0,0 +1,15 @@
+awslabs/__init__.py,sha256=47wJeKcStxEJwX7SVVV2pnAWYR8FxcaYoT3YTmZ5Plg,674
+awslabs/cfn_mcp_server/__init__.py,sha256=0iDzkNDzH_VHat2joZdYA_i2NeOiAWYlorKpKaW1vpE,611
+awslabs/cfn_mcp_server/aws_client.py,sha256=w0cwuQq7b34IUaABEwZYpEols1QoMjO2gd3T98K5FcE,2783
+awslabs/cfn_mcp_server/cloud_control_utils.py,sha256=wUDT-J9iEAOYnqZAG2vDtBsXUp0EUZ__jQzJ4RJ6AvM,2973
+awslabs/cfn_mcp_server/context.py,sha256=YpJZPjyzHW7df9O-lyj2j8yuenZI-yPxLuVuyvmnAnE,777
+awslabs/cfn_mcp_server/errors.py,sha256=0ADg9EesPyvjNZD-J89QLQ5OFcD6aSKDaMfW_4RQjfo,4481
+awslabs/cfn_mcp_server/iac_generator.py,sha256=iTZ6tM92m430GHM60lH1qR5nlRdhSbx2m0_WTbkU1f8,7881
+awslabs/cfn_mcp_server/schema_manager.py,sha256=7dw2W2hgdn1ODRU5PrUmOG9_rvnKUhGD51q8Wz4Ksks,6775
+awslabs/cfn_mcp_server/server.py,sha256=Fw7vMYfzxGCTaJD_MHj1EmGVlTO_CmtOKjzicGj8uYw,16737
+awslabs_cfn_mcp_server-1.0.2.dist-info/METADATA,sha256=MJ_pS10WvMNHDpizR_gAf4bBVQr6hwB1vy1Dwl-F0KY,9121
+awslabs_cfn_mcp_server-1.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+awslabs_cfn_mcp_server-1.0.2.dist-info/entry_points.txt,sha256=Hartc24s_fYgi3o2m2tBHahod0pqXYwpebQy2_tXL7s,78
+awslabs_cfn_mcp_server-1.0.2.dist-info/licenses/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
+awslabs_cfn_mcp_server-1.0.2.dist-info/licenses/NOTICE,sha256=bcw4NZAgn5eQZzrtuDiwOe23BRSm_JiRzn0gxBLDzlg,90
+awslabs_cfn_mcp_server-1.0.2.dist-info/RECORD,,

awslabs_cfn_mcp_server-1.0.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-awslabs/__init__.py,sha256=47wJeKcStxEJwX7SVVV2pnAWYR8FxcaYoT3YTmZ5Plg,674
-awslabs/cfn_mcp_server/__init__.py,sha256=0iDzkNDzH_VHat2joZdYA_i2NeOiAWYlorKpKaW1vpE,611
-awslabs/cfn_mcp_server/aws_client.py,sha256=E7ekLizw0P6q9Pem40UDnhFTHKo5TMYmPeajuFDnMBY,2649
-awslabs/cfn_mcp_server/cloud_control_utils.py,sha256=wUDT-J9iEAOYnqZAG2vDtBsXUp0EUZ__jQzJ4RJ6AvM,2973
-awslabs/cfn_mcp_server/context.py,sha256=YpJZPjyzHW7df9O-lyj2j8yuenZI-yPxLuVuyvmnAnE,777
-awslabs/cfn_mcp_server/errors.py,sha256=rNHaKx9t3xJGLLypSxXO6ec8nl1h19e8_2yYMTmDP4g,4480
-awslabs/cfn_mcp_server/schema_manager.py,sha256=7dw2W2hgdn1ODRU5PrUmOG9_rvnKUhGD51q8Wz4Ksks,6775
-awslabs/cfn_mcp_server/server.py,sha256=9_BTzMPJxr-fc3BhBOia2a3S_xOP9HX2IS0lNZawFS4,13858
-awslabs_cfn_mcp_server-1.0.0.dist-info/METADATA,sha256=PiZrjprpOLgEVLW9UkFPd1AvY-xrtCbLnbr_i0XNj0M,8239
-awslabs_cfn_mcp_server-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-awslabs_cfn_mcp_server-1.0.0.dist-info/entry_points.txt,sha256=Hartc24s_fYgi3o2m2tBHahod0pqXYwpebQy2_tXL7s,78
-awslabs_cfn_mcp_server-1.0.0.dist-info/licenses/LICENSE,sha256=CeipvOyAZxBGUsFoaFqwkx54aPnIKEtm9a5u2uXxEws,10142
-awslabs_cfn_mcp_server-1.0.0.dist-info/licenses/NOTICE,sha256=bcw4NZAgn5eQZzrtuDiwOe23BRSm_JiRzn0gxBLDzlg,90
-awslabs_cfn_mcp_server-1.0.0.dist-info/RECORD,,