infracost_cloud_create_guardrail
Create cost guardrails to notify stakeholders or block pull requests when infrastructure spending exceeds defined thresholds, helping control cloud costs.
Instructions
Create cost guardrails in Infracost Cloud that notify stakeholders or block PRs when cost thresholds are exceeded. Requires INFRACOST_SERVICE_TOKEN environment variable.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orgSlug | No | Organization slug from Infracost Cloud (defaults to INFRACOST_ORG env var) | |
| name | Yes | Name for the guardrail | |
| scope | Yes | Scope configuration | |
| increaseThreshold | No | Threshold for cost increases (monthly dollar amount) | |
| increasePercentThreshold | No | Threshold for cost increases (percentage) | |
| totalThreshold | No | Threshold for total cost (monthly dollar amount) | |
| message | No | Custom message to display when threshold is exceeded | |
| webhookUrl | No | Webhook URL to notify when threshold is exceeded | |
| blockPullRequest | No | Whether to block PR when threshold is exceeded | |
| commentOnPullRequest | No | Whether to comment on PR when threshold is exceeded |
Implementation Reference
- src/tools.ts:433-503 (handler)The primary handler method in InfracostTools class that executes the tool logic: validates arguments, maps scope and notifications to API format, calls the cloud API client to create the guardrail, and returns the result.async handleCreateGuardrail(args: z.infer<typeof CreateGuardrailSchema>) { 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: _, scope, blockPullRequest, commentOnPullRequest, webhookUrl, emailRecipientOrgMemberIds, mailingListEmails, msTeamsEmails, ...rest } = args; let scopeString: string; if (scope.type === 'ALL_PROJECTS' || scope.type === 'REPO') { scopeString = 'REPO'; } else { scopeString = '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 }; } const apiRequest: any = { ...rest, scope: scopeString, filters: Object.keys(filters).length > 0 ? filters : undefined, prComment: commentOnPullRequest, blockPr: blockPullRequest, webhookUrl, // Schema defaults to empty string if not provided }; if (emailRecipientOrgMemberIds) { apiRequest.emailRecipientOrgMemberIds = emailRecipientOrgMemberIds; } if (mailingListEmails) { apiRequest.mailingListEmails = mailingListEmails; } if (msTeamsEmails) { apiRequest.msTeamsEmails = msTeamsEmails; } const result = await this.cloudApiClient.createGuardrail(orgSlug, apiRequest); if (!result.success) { throw new Error(result.error || 'Create guardrail request failed'); } return { content: [ { type: 'text', text: result.output || 'Guardrail created successfully', }, ], }; }
- src/tools.ts:108-151 (schema)Zod schema defining input validation and descriptions for the tool's parameters.export const CreateGuardrailSchema = z.object({ orgSlug: z.string().optional().describe('Organization slug from Infracost Cloud (defaults to INFRACOST_ORG env var)'), name: z.string().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)'), }) .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:521-589 (registration)Tool registration in the ListTools handler, providing name, description, and input schema (derived from CreateGuardrailSchema).{ name: 'infracost_cloud_create_guardrail', description: 'Create cost guardrails in Infracost Cloud that notify stakeholders or block PRs when cost thresholds are exceeded. 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)', }, name: { type: 'string', description: 'Name for the guardrail', }, scope: { type: 'object', description: 'Scope configuration', properties: { type: { type: 'string', enum: ['ALL_PROJECTS', 'REPO', 'PROJECT'], description: 'Scope type for the guardrail', }, repositories: { type: 'array', items: { type: 'string' }, description: 'Repository names (for REPO scope)', }, projects: { type: 'array', items: { type: 'string' }, description: 'Project names (for PROJECT scope)', }, }, required: ['type'], }, 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: ['name', 'scope'], }, },
- src/index.ts:764-767 (registration)Dispatch case in CallToolRequestHandler that parses arguments with the schema and invokes the handler.case 'infracost_cloud_create_guardrail': { const validatedArgs = CreateGuardrailSchema.parse(args); return await tools.handleCreateGuardrail(validatedArgs); }
- src/api.ts:277-312 (helper)Core API client helper that performs the HTTP POST request to Infracost Cloud API to create the guardrail.async createGuardrail( orgSlug: string, request: CreateGuardrailRequest ): Promise<CommandResult> { try { const response = await fetch(`${INFRACOST_CLOUD_API_BASE}/orgs/${orgSlug}/guardrails`, { method: 'POST', 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', }; } }