Skip to main content
Glama

infracost_cloud_update_guardrail

Modify cost guardrails in Infracost Cloud to monitor infrastructure spending thresholds, configure notifications, and control pull request actions based on cost changes.

Instructions

Update an existing guardrail in Infracost Cloud. Requires INFRACOST_SERVICE_TOKEN environment variable.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgSlugNoOrganization slug from Infracost Cloud (defaults to INFRACOST_ORG env var)
guardrailIdYesGuardrail ID
nameNoName for the guardrail
filtersNoFilters to limit scope of the guardrail
increaseThresholdNoThreshold for cost increases (monthly dollar amount)
increasePercentThresholdNoThreshold for cost increases (percentage)
totalThresholdNoThreshold for total cost (monthly dollar amount)
messageNoCustom message to display when threshold is exceeded
webhookUrlNoWebhook URL to notify when threshold is exceeded
blockPullRequestNoWhether to block PR when threshold is exceeded
commentOnPullRequestNoWhether to comment on PR when threshold is exceeded

Implementation Reference

  • Main handler function that validates input, prepares the API request by transforming scope and notification settings, calls the Cloud API client to update the guardrail, and returns the result.
    async handleUpdateGuardrail(args: z.infer<typeof UpdateGuardrailSchema>) {
      if (!this.cloudApiClient) {
        throw new Error('INFRACOST_SERVICE_TOKEN is not configured for Infracost Cloud API operations');
      }
    
      const orgSlug = args.orgSlug || this.config.orgSlug;
      if (!orgSlug) {
        throw new Error('Organization slug is required. Provide it via orgSlug parameter or set INFRACOST_ORG environment variable');
      }
    
      const {
        orgSlug: _,
        guardrailId,
        scope,
        blockPullRequest,
        commentOnPullRequest,
        emailRecipientOrgMemberIds,
        mailingListEmails,
        msTeamsEmails,
        ...rest
      } = args;
    
      const apiRequest: any = {
        ...rest,
      };
    
      if (scope) {
        if (scope.type === 'ALL_PROJECTS' || scope.type === 'REPO') {
          apiRequest.scope = 'REPO';
        } else {
          apiRequest.scope = 'PROJECT';
        }
        const filters: any = {};
    
        if (scope.repositories && scope.repositories.length > 0) {
          filters.repos = { include: scope.repositories };
        }
        if (scope.projects && scope.projects.length > 0) {
          filters.projects = { include: scope.projects };
        }
    
        if (Object.keys(filters).length > 0) {
          apiRequest.filters = filters;
        }
      }
    
      if (commentOnPullRequest !== undefined) {
        apiRequest.prComment = commentOnPullRequest;
      }
      if (blockPullRequest !== undefined) {
        apiRequest.blockPr = blockPullRequest;
      }
      if (emailRecipientOrgMemberIds !== undefined) {
        apiRequest.emailRecipientOrgMemberIds = emailRecipientOrgMemberIds;
      }
      if (mailingListEmails !== undefined) {
        apiRequest.mailingListEmails = mailingListEmails;
      }
      if (msTeamsEmails !== undefined) {
        apiRequest.msTeamsEmails = msTeamsEmails;
      }
    
      const result = await this.cloudApiClient.updateGuardrail(orgSlug, guardrailId, apiRequest);
    
      if (!result.success) {
        throw new Error(result.error || 'Update guardrail request failed');
      }
    
      return {
        content: [
          {
            type: 'text',
            text: result.output || 'Guardrail updated successfully',
          },
        ],
      };
    }
  • Zod schema defining the input parameters for the tool, including guardrail ID, thresholds, scope, notifications, etc.
    export const UpdateGuardrailSchema = z.object({
      orgSlug: z.string().optional().describe('Organization slug from Infracost Cloud (defaults to INFRACOST_ORG env var)'),
      guardrailId: z.string().describe('Guardrail ID'),
      name: z.string().optional().describe('Name for the guardrail'),
      scope: z
        .object({
          type: z
            .enum(['ALL_PROJECTS', 'REPO', 'PROJECT'])
            .describe('Scope type for the guardrail'),
          repositories: z.array(z.string()).optional().describe('Repository names (for REPO scope)'),
          projects: z.array(z.string()).optional().describe('Project names (for PROJECT scope)'),
        })
        .optional()
        .describe('Scope configuration'),
      increaseThreshold: z
        .number()
        .optional()
        .describe('Threshold for cost increases (monthly dollar amount)'),
      increasePercentThreshold: z
        .number()
        .optional()
        .describe('Threshold for cost increases (percentage)'),
      totalThreshold: z
        .number()
        .optional()
        .describe('Threshold for total cost (monthly dollar amount)'),
      message: z.string().optional().describe('Custom message to display when threshold is exceeded'),
      webhookUrl: z.string().default('').describe('Webhook URL to notify when threshold is exceeded (defaults to empty string if not needed)'),
      blockPullRequest: z.boolean().optional().describe('Whether to block PR when threshold is exceeded'),
      commentOnPullRequest: z
        .boolean()
        .optional()
        .describe('Whether to comment on PR when threshold is exceeded'),
      emailRecipientOrgMemberIds: z
        .array(z.string())
        .optional()
        .describe('Array of organization member IDs to email'),
      mailingListEmails: z
        .array(z.string())
        .optional()
        .describe('Array of email addresses to notify'),
      msTeamsEmails: z
        .array(z.string())
        .optional()
        .describe('Array of MS Teams email addresses to notify'),
    });
  • src/index.ts:769-772 (registration)
    Switch case in CallToolRequestSchema handler that parses arguments with UpdateGuardrailSchema and delegates to InfracostTools.handleUpdateGuardrail.
    case 'infracost_cloud_update_guardrail': {
      const validatedArgs = UpdateGuardrailSchema.parse(args);
      return await tools.handleUpdateGuardrail(validatedArgs);
    }
  • src/index.ts:590-656 (registration)
    Tool registration in ListToolsRequestSchema response, including name, description, and input schema.
    {
      name: 'infracost_cloud_update_guardrail',
      description:
        'Update an existing guardrail in Infracost Cloud. Requires INFRACOST_SERVICE_TOKEN environment variable.',
      inputSchema: {
        type: 'object',
        properties: {
          orgSlug: {
            type: 'string',
            description: 'Organization slug from Infracost Cloud (defaults to INFRACOST_ORG env var)',
          },
          guardrailId: {
            type: 'string',
            description: 'Guardrail ID',
          },
          name: {
            type: 'string',
            description: 'Name for the guardrail',
          },
          filters: {
            type: 'array',
            description: 'Filters to limit scope of the guardrail',
            items: {
              type: 'object',
              properties: {
                type: {
                  type: 'string',
                  enum: ['project', 'repository'],
                  description: 'Filter type',
                },
                value: { type: 'string', description: 'Filter value' },
              },
              required: ['type', 'value'],
            },
          },
          increaseThreshold: {
            type: 'number',
            description: 'Threshold for cost increases (monthly dollar amount)',
          },
          increasePercentThreshold: {
            type: 'number',
            description: 'Threshold for cost increases (percentage)',
          },
          totalThreshold: {
            type: 'number',
            description: 'Threshold for total cost (monthly dollar amount)',
          },
          message: {
            type: 'string',
            description: 'Custom message to display when threshold is exceeded',
          },
          webhookUrl: {
            type: 'string',
            description: 'Webhook URL to notify when threshold is exceeded',
          },
          blockPullRequest: {
            type: 'boolean',
            description: 'Whether to block PR when threshold is exceeded',
          },
          commentOnPullRequest: {
            type: 'boolean',
            description: 'Whether to comment on PR when threshold is exceeded',
          },
        },
        required: ['guardrailId'],
      },
    },
  • API client method that performs the PATCH request to the Infracost Cloud API endpoint to update the guardrail.
    async updateGuardrail(
      orgSlug: string,
      guardrailId: string,
      request: UpdateGuardrailRequest
    ): Promise<CommandResult> {
      try {
        const response = await fetch(
          `${INFRACOST_CLOUD_API_BASE}/orgs/${orgSlug}/guardrails/${guardrailId}`,
          {
            method: 'PATCH',
            headers: {
              'Content-Type': 'application/json',
              Authorization: `Bearer ${this.serviceToken}`,
            },
            body: JSON.stringify({ data: { type: 'guardrails', attributes: request } }),
          }
        );
    
        if (!response.ok) {
          const errorText = await response.text();
          return {
            success: false,
            error: `API request failed with status ${response.status}: ${errorText}`,
          };
        }
    
        const data = await response.json();
    
        return {
          success: true,
          output: JSON.stringify(data, null, 2),
          data,
        };
      } catch (error) {
        return {
          success: false,
          error: error instanceof Error ? error.message : 'Unknown error occurred',
        };
      }
    }
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions the environment variable requirement, which is useful context, but fails to describe important behavioral aspects: what 'update' entails (partial vs. full updates), whether changes are reversible, what happens to unspecified fields, error conditions, or rate limits. For a mutation tool with 11 parameters, this is insufficient.

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

Conciseness4/5

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

The description is appropriately concise with just two sentences that get straight to the point. The first sentence states the core purpose, and the second provides essential authentication context. There's no wasted verbiage, though it could be slightly more structured for optimal front-loading.

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 (11 parameters, mutation operation, no annotations, no output schema), the description is incomplete. It lacks information about what the tool returns, error handling, update behavior (partial/full), and how it differs from sibling tools. The environment variable mention helps but doesn't compensate for these significant gaps.

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

Parameters3/5

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

The schema description coverage is 100%, meaning all parameters are documented in the schema itself. The description adds no additional parameter information beyond what's already in the schema. According to the scoring rules, when schema coverage is high (>80%), the baseline score is 3 even with no param info in the description.

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

Purpose4/5

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

The description clearly states the action ('Update') and resource ('an existing guardrail in Infracost Cloud'), making the purpose immediately understandable. However, it doesn't differentiate this tool from its sibling 'infracost_cloud_update_tagging_policy' or other update operations, which would be needed for a perfect score.

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?

The description mentions an environment variable requirement ('Requires INFRACOST_SERVICE_TOKEN'), which provides some usage context. However, it offers no guidance on when to use this tool versus alternatives like 'infracost_cloud_create_guardrail' or 'infracost_cloud_delete_guardrail', nor does it explain prerequisites beyond the token.

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/phildougherty/infracost_mcp'

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