Skip to main content
Glama

aws_cloudformation

Manage AWS CloudFormation stacks to deploy and control infrastructure resources. Use this tool to create, update, delete, or list stacks with specified templates and parameters.

Instructions

Manage AWS CloudFormation stacks

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
actionYes
regionYes
stackNameNo
templateBodyNo
templateUrlNo
parametersNo
capabilitiesNo
tagsNo

Implementation Reference

  • The main handler function for the 'aws_cloudformation' tool. It generates an Ansible playbook based on the action (list, create, update, delete) and parameters, handles template files, and executes the playbook using executeAwsPlaybook.
    export async function cloudFormationOperations(args: CloudFormationOptions): Promise<string> {
      await verifyAwsCredentials();
    
      const { action, region, stackName, templateBody, templateUrl, parameters, capabilities, tags } = args;
    
      const tempFiles: { filename: string, content: string }[] = [];
      let templateParam = '';
    
      if (templateBody) {
        // Prepare template body to be written to a temp file
        tempFiles.push({ filename: 'template.cfn', content: templateBody });
        templateParam = 'template: "template.cfn"'; // Reference the temp file name
      } else if (templateUrl) {
        templateParam = `template_url: "${templateUrl}"`;
      } else if (action === 'create' || action === 'update') {
        // Template is required for create/update
        throw new AnsibleError('Either templateBody or templateUrl must be provided for CloudFormation create/update actions.');
      }
    
      let playbookContent = `---
    - name: AWS CloudFormation ${action} operation
      hosts: localhost
      connection: local
      gather_facts: no
      tasks:`;
      
      switch (action) {
        case 'list':
          playbookContent += `
        - name: List CloudFormation stacks
          amazon.aws.cloudformation_info:
            region: "${region}"
          register: cfn_info
        
        - name: Display stacks
          debug:
            var: cfn_info.stacks`;
          break;
          
        case 'create':
        case 'update':
          playbookContent += `
        - name: ${action === 'create' ? 'Create' : 'Update'} CloudFormation stack
          amazon.aws.cloudformation:
            region: "${region}"
            stack_name: "${stackName}"
            state: present
            ${templateParam} # Use the determined template parameter
    ${formatYamlParams({
      template_parameters: parameters,
      capabilities,
      tags
    })}
          register: cfn_result
        
        - name: Display stack outputs/result
          debug:
            var: cfn_result`;
          break;
          
        case 'delete':
          playbookContent += `
        - name: Delete CloudFormation stack
          amazon.aws.cloudformation:
            region: "${region}"
            stack_name: "${stackName}"
            state: absent
          register: cfn_delete
          
        - name: Display deletion result
          debug:
            var: cfn_delete`;
          break;
          
        default:
          throw new AnsibleError(`Unsupported CloudFormation action: ${action}`);
      }
      
      // Execute the generated playbook, passing template body if needed
      return executeAwsPlaybook(`cloudformation-${action}`, playbookContent, '', tempFiles);
    }
  • Registration of the 'aws_cloudformation' tool in the toolDefinitions map, linking its description, input schema, and handler function.
    aws_cloudformation: {
      description: 'Manage AWS CloudFormation stacks',
      schema: aws.CloudFormationSchema,
      handler: aws.cloudFormationOperations,
    },
  • Zod schema defining the input validation for the 'aws_cloudformation' tool, including action enum, required region, and optional parameters like stackName, templateBody, etc.
    export const CloudFormationSchema = z.object({
      action: CloudFormationActionEnum,
      region: z.string().min(1, 'AWS region is required'),
      stackName: z.string().optional(),
      templateBody: z.string().optional(),
      templateUrl: z.string().optional(),
      parameters: z.record(z.any()).optional(),
      capabilities: z.array(z.string()).optional(),
      tags: z.record(z.string()).optional()
    });
    
    export type CloudFormationOptions = z.infer<typeof CloudFormationSchema>;
  • Zod enum defining the supported actions for the 'aws_cloudformation' tool: list, create, update, delete.
    export const CloudFormationActionEnum = z.enum(['list', 'create', 'update', 'delete']);
    export type CloudFormationAction = z.infer<typeof CloudFormationActionEnum>;
  • Helper function used by the handler to execute dynamically generated Ansible playbooks for AWS operations, handling temporary files and directories.
    async function executeAwsPlaybook(
      operationName: string, 
      playbookContent: string, 
      extraParams: string = '',
      tempFiles: { filename: string, content: string }[] = [] // For additional files like templates, policies
    ): Promise<string> {
      let tempDir: string | undefined;
      try {
        // Create a unique temporary directory
        tempDir = await createTempDirectory(`ansible-aws-${operationName}`);
        
        // Write the main playbook file
        const playbookPath = await writeTempFile(tempDir, 'playbook.yml', playbookContent);
        
        // Write any additional temporary files
        for (const file of tempFiles) {
          await writeTempFile(tempDir, file.filename, file.content);
        }
    
        // Build the command
        const command = `ansible-playbook ${playbookPath} ${extraParams}`;
        console.error(`Executing: ${command}`);
    
        // Execute the playbook asynchronously
        const { stdout, stderr } = await execAsync(command);
        
        // Return stdout, or a success message if stdout is empty
        return stdout || `${operationName} completed successfully (no output).`;
    
      } catch (error: any) {
        // Handle execution errors
        const errorMessage = error.stderr || error.message || 'Unknown error';
        throw new AnsibleExecutionError(`Ansible execution failed for ${operationName}: ${errorMessage}`, error.stderr);
      } finally {
        // Ensure cleanup happens even if errors occur
        if (tempDir) {
          await cleanupTempDirectory(tempDir);
        }
      }
    }
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries full burden but only states 'manage' without disclosing behavioral traits. It doesn't mention that actions can be destructive (create/update/delete), authentication needs, rate limits, or what the tool returns. This is inadequate for a tool with multiple mutation actions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words. It's appropriately sized and front-loaded, though it under-specifies rather than being concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (8 parameters, multiple actions including mutations), no annotations, and no output schema, the description is incomplete. It doesn't explain what the tool returns, error conditions, or behavioral details needed for safe and effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate but adds no parameter information. It doesn't explain what 'action' values do, the purpose of 'region', 'stackName', or other parameters. The description fails to provide meaning beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Manage AWS CloudFormation stacks' states the general purpose (verb+resource) but is vague about what 'manage' entails. It distinguishes from sibling tools by specifying CloudFormation, but doesn't clarify the specific operations available (list, create, update, delete) beyond what the schema shows.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance on when to use this tool versus alternatives like terraform or other AWS tools (e.g., aws_ec2, aws_lambda). The description implies usage for CloudFormation stacks but provides no context on prerequisites, dependencies, or exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/tarnover/mcp-sysoperator'

If you have feedback or need assistance with the MCP directory API, please join our Discord server