Skip to main content
Glama

get-cost-forecast

Forecast Google Cloud Platform project costs for upcoming months to help with budget planning and resource management.

Instructions

Get cost forecast for the current project

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdNoProject ID to get forecast for (defaults to selected project)
monthsNoNumber of months to forecast (default: 3)

Implementation Reference

  • Executes the get-cost-forecast tool by retrieving billing account information for the project (note: does not actually compute a forecast, returns basic billing status).
    } else if (name === "get-cost-forecast") {
      const { projectId, months = 3 } = GetCostForecastSchema.parse(args);
      const targetProject = projectId || selectedProject;
      
      if (!targetProject) {
        return createTextResponse("No project selected. Please select a project first.");
      }
    
      try {
        const billingClient = new CloudBillingClient();
        const [billingInfo] = await billingClient.getProjectBillingInfo({
          name: `projects/${targetProject}`
        });
    
        if (!billingInfo.billingEnabled) {
          return createTextResponse("Billing is not enabled for this project.");
        }
    
        const billingAccount = billingInfo.billingAccountName;
        if (!billingAccount) {
          return createTextResponse("No billing account associated with this project.");
        }
    
        // Get cost forecast using Cloud Billing API
        const [costInfo] = await billingClient.getProjectBillingInfo({
          name: `projects/${targetProject}`
        });
    
        return createTextResponse(JSON.stringify({
          projectId: targetProject,
          billingAccount: billingAccount,
          billingEnabled: costInfo.billingEnabled,
          currency: 'USD'
        }, null, 2));
      } catch (error: any) {
        console.error('Error getting cost forecast:', error);
        if (error.code === 7) {
          return createTextResponse("Error: Cloud Billing API is not enabled. Please enable it in the Google Cloud Console.");
        }
        return createTextResponse(`Error getting cost forecast: ${error.message}`);
      }
  • index.ts:139-156 (registration)
    Registers the 'get-cost-forecast' tool in the list of available tools, including its description and input schema.
    {
      name: "get-cost-forecast",
      description: "Get cost forecast for the current project",
      inputSchema: {
        type: "object",
        properties: {
          projectId: {
            type: "string",
            description: "Project ID to get forecast for (defaults to selected project)",
          },
          months: {
            type: "number",
            description: "Number of months to forecast (default: 3)",
          },
        },
        required: [],
      },
    },
  • Zod schema used for input validation in the get-cost-forecast handler.
    const GetCostForecastSchema = z.object({
      projectId: z.string().optional(),
      months: z.number().optional(),
    });

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior2/5

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

Without annotations, the description must carry the burden of behavioral disclosure. It only states it gets a forecast, implying read-only, but lacks details on output format, authorization needs, rate limits, or any side effects. This is insufficient for safe agent invocation.

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 a single sentence, front-loading the core action. It is concise and efficiently communicates the purpose, though it may be too brief for complex usage.

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 simplicity (2 optional params, no output schema), the description is too minimal. It fails to explain return values, how the forecast is calculated, or dependencies like project selection. An agent lacks sufficient context to confidently invoke the tool.

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?

Schema coverage is 100%, so baseline is 3. The description adds no new meaning beyond the schema; the param descriptions already explain 'months' and 'projectId'. No additional context is provided about defaults or interactions.

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

Purpose5/5

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

The description clearly states the action (Get) and resource (cost forecast) with a specific scope (current project). It distinguishes from siblings like 'get-billing-budget' and 'get-billing-info' by focusing on forecasting, which is a distinct concept.

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 provides no guidance on when to use this tool versus alternatives such as 'get-billing-budget' or 'get-billing-info'. There is no mention of prerequisites, limitations, or context for usage.

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