@google-cloud/cloud-run-mcp 1.5.0 → 1.7.0

package/.c8rc.json

@@ -0,0 +1,9 @@
+{
+  "all": true,
+  "reporter": ["lcov", "text"],
+  "lines": 43,
+  "functions": 35,
+  "branches": 70,
+  "statements": 43,
+  "exclude": ["**/test/**", "**/coverage/**"]
+}

package/.github/workflows/lint-checker.yml

@@ -0,0 +1,17 @@
+name: Run Lint Checker
+
+on:
+  push:
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm run lint:check

package/.github/workflows/npm-publish.yml

@@ -2,7 +2,7 @@ name: Publish to npm
 
 on:
   release:
-    types: [created]
+    types: [published]
 
 jobs:
   publish-npm:

package/.kokoro/kokoro_build.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Code under repo is checked out to ${KOKORO_ARTIFACTS_DIR}/git.
+# The final directory name in this path is determined by the scm name specified
+# in the job configuration.
+
+cd "${KOKORO_ARTIFACTS_DIR}/github/cloud-run-mcp"
+.kokoro/run_tests.sh

package/.kokoro/presubmit.cfg

@@ -0,0 +1,21 @@
+# -*- protobuffer -*-
+# proto-file: google3/devtools/kokoro/config/proto/build.proto
+# proto-message: BuildConfig
+
+# Location of the bash script. Should have value <github_scm.name>/<path_from_repository_root>.
+# github_scm.name is specified in the job configuration (next section).
+build_file: "cloud-run-mcp/.kokoro/kokoro_build.sh"
+
+container_properties {
+  docker_image: "us-central1-docker.pkg.dev/kokoro-container-bakery/kokoro/ubuntu/ubuntu2204/full:next"
+}
+
+env_vars {
+  key: "GOOGLE_CLOUD_PROJECT"
+  value: "cloud-run-mcp-server-testing"
+}
+
+env_vars {
+  key: "GCP_PARENT"
+  value: "folders/138095058155"
+}

package/.kokoro/run_tests.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+#
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Fail on any error.
+set -xe
+
+# cd to project root
+cd "$(dirname "$0")"/..
+
+# Install dependencies
+npm install
+
+# Run tests
+npm run test:workflows # Run tests related to all workflows
+npm run test:projects # Run tests related to GCP projects
+npm run test:services # Run tests related to services
+npm run test:deploy # Run tests related to deployments
+npm run test:gcp-auth # Run tests related to GCP authentication

package/CONTRIBUTING.md

@@ -74,7 +74,7 @@ To use remote MCP Server in a MCP client:
 Start the MCP server locally with:
 
 ```bash
-npm run start
+GCP_STDIO=false node /path/to/this/repo/cloud-run-mcp/mcp-server.js
 ```
 
 Then, in your MCP client configuration, use the following:
@@ -84,7 +84,19 @@ Then, in your MCP client configuration, use the following:
   "mcpServers": {
     "cloud-run": {
       "command": "npx",
-      "args": ["mcp-remote", "http://localhost:3000/sse"]
+      "args": ["mcp-remote", "http://localhost:3000/mcp"]
+    }
+  }
+}
+```
+
+or, if your client supports the `url` attribute, you can use:
+
+```
+{
+  "mcpServers": {
+    "cloud-run": {
+      "url": "http://localhost:3000/mcp"
     }
   }
 }
@@ -114,14 +126,17 @@ This script requires an existing Google Cloud Project ID to be provided when pro
 
 ## Publishing to npm
 
-To update the [npm package]https://www.npmjs.com/package/@google-cloud/cloud-run-mcp)
+To update the [npm package](https://www.npmjs.com/package/@google-cloud/cloud-run-mcp)
 
 Run the following:
 
-* `git checkout -b new-release`
-* `npm test`
-* `npm version minor`
-* `git push --follow-tags`
-* On GitHub, [create a new release](https://github.com/GoogleCloudPlatform/cloud-run-mcp/releases/new) for this tag.
+- `git checkout -b new-release`
+- `npm test`
+- `npm version minor`
+- `git push --set-upstream origin new-release --follow-tags`
+- Create a [pull request for 'new-release' on GitHub](https://github.com/GoogleCloudPlatform/cloud-run-mcp/pull/new/new-release)
+- Get approval
+- Rebase and merge into main
+- On GitHub, [create a new release](https://github.com/GoogleCloudPlatform/cloud-run-mcp/releases/new) for this tag.
 
-Then a [GitHub Action]https://github.com/GoogleCloudPlatform/cloud-run-mcp/blob/main/.github/workflows/npm-publish.yml) automatically publishes to npm when new releases are pushes.
+Then a [GitHub Action](https://github.com/GoogleCloudPlatform/cloud-run-mcp/blob/main/.github/workflows/npm-publish.yml) automatically publishes to npm when new releases are pushes.

package/README.md

@@ -1,4 +1,4 @@
-# MCP server to deploy code to Google Cloud Run
+# Cloud Run MCP server and Gemini CLI extension
 
 Enable MCP-compatible AI agents to deploy apps to Cloud Run.
 
@@ -11,7 +11,7 @@ Enable MCP-compatible AI agents to deploy apps to Cloud Run.
 }
 ```
 
-Deploy from Gemini CLI and other AI-powered CLI agents:  
+Deploy from Gemini CLI and other AI-powered CLI agents:
 
 <img  src="https://raw.githubusercontent.com/GoogleCloudPlatform/cloud-run-mcp/refs/heads/main/.github/images/deploycli.gif" width="800">
 
@@ -48,19 +48,58 @@ Prompts are natural language commands that can be used to perform common tasks.
 - `deploy`: Deploys the current working directory to Cloud Run. If a service name is not provided, it will use the `DEFAULT_SERVICE_NAME` environment variable, or the name of the current working directory.
 - `logs`: Gets the logs for a Cloud Run service. If a service name is not provided, it will use the `DEFAULT_SERVICE_NAME` environment variable, or the name of the current working directory.
 
+## Environment Variables
+
+The Cloud Run MCP server can be configured using the following environment variables:
+
+| Variable                 | Description                                                                                                                                                                              |
+| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `GOOGLE_CLOUD_PROJECT`   | The default project ID to use for Cloud Run services.                                                                                                                                    |
+| `GOOGLE_CLOUD_REGION`    | The default region to use for Cloud Run services.                                                                                                                                        |
+| `DEFAULT_SERVICE_NAME`   | The default service name to use for Cloud Run services.                                                                                                                                  |
+| `SKIP_IAM_CHECK`         | Controls whether to check for IAM permissions for a Cloud Run service. Set to `false` to enable checks. This is `true` by default which is a recommended way to make the service public. |
+| `ENABLE_HOST_VALIDATION` | Prevents [DNS Rebinding](https://en.wikipedia.org/wiki/DNS_rebinding) attacks by validating the Host header. This is disabled by default.                                                |
+| `ALLOWED_HOSTS`          | Comma-separated list of allowed Host headers (if host validation is enabled). The default value is `localhost,127.0.0.1,::1`.                                                            |
 
 ## Use as a Gemini CLI extension
 
 To install this as a [Gemini CLI](https://github.com/google-gemini/gemini-cli) extension, run the following command:
 
-```bash
-mkdir -p ~/.gemini/extensions/cloud-run/gemini-extension && \
-  curl -s -L https://raw.githubusercontent.com/GoogleCloudPlatform/cloud-run-mcp/main/gemini-extension.json > ~/.gemini/extensions/cloud-run/gemini-extension.json && \
-  curl -s -L https://raw.githubusercontent.com/GoogleCloudPlatform/cloud-run-mcp/main/gemini-extension/GEMINI.md > ~/.gemini/extensions/cloud-run/gemini-extension/GEMINI.md
-```
+2. Install the extension:
 
+   ```bash
+   gemini extensions install https://github.com/GoogleCloudPlatform/cloud-run-mcp
+   ```
 
-## Use as local MCP server
+3. Log in to your Google Cloud account using the command:
+
+   ```bash
+   gcloud auth login
+   ```
+
+4. Set up application credentials using the command:
+   ```bash
+   gcloud auth application-default login
+   ```
+
+## Use in MCP Clients
+
+### Learn how to configure your MCP client
+
+Most MCP clients require a configuration file to be created or modified to add the MCP server.
+
+The configuration file syntax can be different across clients. Please refer to the following links for the latest expected syntax:
+
+- [**Antigravity**](https://antigravity.google/docs/mcp)
+- [**Windsurf**](https://docs.windsurf.com/windsurf/mcp)
+- [**VSCode**](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
+- [**Claude Desktop**](https://modelcontextprotocol.io/quickstart/user)
+- [**Cursor**](https://docs.cursor.com/context/model-context-protocol)
+
+Once you have identified how to configure your MCP client, select one of these two options to set up the MCP server.
+We recommend setting up as a local MCP server using Node.js.
+
+### Set up as local MCP server
 
 Run the Cloud Run MCP server on your local machine using local Google Cloud credentials. This is best if you are using an AI-assisted IDE (e.g. Cursor) or a desktop AI application (e.g. Claude).
 
@@ -79,7 +118,7 @@ Run the Cloud Run MCP server on your local machine using local Google Cloud cred
 
 Then configure the MCP server using either Node.js or Docker:
 
-### Using Node.js
+#### Using Node.js
 
 0. Install [Node.js](https://nodejs.org/en/download/) (LTS version recommended).
 
@@ -106,7 +145,7 @@ Then configure the MCP server using either Node.js or Docker:
       }
    ```
 
-### Using Docker
+#### Using Docker
 
 See Docker's [MCP catalog](https://hub.docker.com/mcp/server/cloud-run-mcp/overview), or use these manual instructions:
 
@@ -134,7 +173,7 @@ See Docker's [MCP catalog](https://hub.docker.com/mcp/server/cloud-run-mcp/overv
       }
    ```
 
-## Use as remote MCP server
+### Set up as remote MCP server
 
 > [!WARNING]  
 > Do not use the remote MCP server without authentication. In the following instructions, we will use IAM authentication to secure the connection to the MCP server from your local machine. This is important to prevent unauthorized access to your Google Cloud resources.
@@ -195,3 +234,5 @@ With this option, you will only be able to deploy code to the same Google Cloud
         "args": ["-y", "mcp-remote", "http://localhost:3000/sse"]
       }
    ```
+
+The Google Cloud Platform Terms of Service (available at https://cloud.google.com/terms/) and the Data Processing and Security Terms (available at https://cloud.google.com/terms/data-processing-terms) do not apply to any component of the Cloud Run MCP Server software.

package/REVIEWING.md

@@ -0,0 +1,20 @@
+# Reviewing Pull Requests
+
+This document provides guidelines for reviewing Pull Requests.
+
+## Guidelines
+
+### Presubmit Tests
+
+Running presubmit tests is a mandatory requirement for Pull Requests to be eligible for submission.
+
+**Before triggering tests:**
+Review the code changes, especially new or modified tests, to ensure they do not contain any malicious or harmful code that could unnecessarily consume or harm Google's resources during test execution. In particular, ensure the tests:
+
+- **Do not modify environment variables:** The tests should not modify environment variables in an unexpected or harmful way.
+- **Do not consume excessive resources:** Ensure tests do not create an excessive number of Google Cloud projects or other high-cost resources.
+- **Do not contain hardcoded credentials:** Credentials should not be present in the code.
+- **Do not rely on untrusted external dependencies:** Any new external dependencies should be reviewed for trustworthiness.
+
+**Triggering tests:**
+If the code is safe to run, trigger presubmit tests by adding a comment with `kokoro:run` to the Pull Request. Tests are run via Kokoro.

package/gemini-extension/GEMINI.md

@@ -3,7 +3,7 @@
 ## Code that can be deployed
 
 Only web servers can be deployed using this MCP server.
-The code needs to listen for HTTP reqeusts on the port defined by the $PORT environment variable or 8080.
+The code needs to listen for HTTP requests on the port defined by the $PORT environment variable or 8080.
 
 ### Supported languages
 

package/lib/cloud-api/billing.js

@@ -0,0 +1,183 @@
+/*
+Copyright 2025 Google LLC
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+/**
+ * Lists all accessible Google Cloud Billing Accounts.
+ * @async
+ * @function listBillingAccounts
+ * @returns {Promise<Array<{name: string, displayName: string, open: boolean}>>} A promise that resolves to an array of billing account objects,
+ * each with 'name', 'displayName', and 'open' status. Returns an empty array on error.
+ */
+export async function listBillingAccounts() {
+  const { CloudBillingClient } = await import('@google-cloud/billing');
+  const client = new CloudBillingClient();
+  try {
+    const [accounts] = await client.listBillingAccounts();
+    if (!accounts || accounts.length === 0) {
+      console.log('No billing accounts found.');
+      return [];
+    }
+    return accounts.map((account) => ({
+      name: account.name, // e.g., billingAccounts/0X0X0X-0X0X0X-0X0X0X
+      displayName: account.displayName,
+      open: account.open,
+    }));
+  } catch (error) {
+    console.error('Error listing GCP billing accounts:', error);
+    return [];
+  }
+}
+
+/**
+ * Attaches a Google Cloud Project to a specified Billing Account.
+ * @async
+ * @function attachProjectToBillingAccount
+ * @param {string} projectId - The ID of the project to attach.
+ * @param {string} billingAccountName - The resource name of the billing account (e.g., 'billingAccounts/0X0X0X-0X0X0X-0X0X0X').
+ * @returns {Promise<object|null>} A promise that resolves to the updated project billing information object if successful, or null on error.
+ */
+export async function attachProjectToBillingAccount(
+  projectId,
+  billingAccountName
+) {
+  const { CloudBillingClient } = await import('@google-cloud/billing');
+  const client = new CloudBillingClient();
+  const projectName = `projects/${projectId}`;
+
+  if (!projectId) {
+    console.error('Error: projectId is required.');
+    return null;
+  }
+  if (
+    !billingAccountName ||
+    !billingAccountName.startsWith('billingAccounts/')
+  ) {
+    console.error(
+      'Error: billingAccountName is required and must be in the format "billingAccounts/XXXXXX-XXXXXX-XXXXXX".'
+    );
+    return null;
+  }
+
+  try {
+    console.log(
+      `Attempting to attach project ${projectId} to billing account ${billingAccountName}...`
+    );
+    const [updatedBillingInfo] = await client.updateProjectBillingInfo({
+      name: projectName,
+      projectBillingInfo: {
+        billingAccountName: billingAccountName,
+      },
+    });
+    console.log(
+      `Successfully attached project ${projectId} to billing account ${billingAccountName}.`
+    );
+    console.log(`Billing enabled: ${updatedBillingInfo.billingEnabled}`);
+    return updatedBillingInfo;
+  } catch (error) {
+    console.error(
+      `Error attaching project ${projectId} to billing account ${billingAccountName}:`,
+      error.message || error
+    );
+    // Log more details if available, e.g. error.details
+    // if (error.details) console.error("Error details:", error.details);
+    return null;
+  }
+}
+
+/**
+ * Checks if billing is enabled for a given project.
+ * @async
+ * @function isBillingEnabled
+ * @param {string} projectId - The ID of the project to check.
+ * @returns {Promise<boolean>} A promise that resolves to true if billing is enabled, false otherwise.
+ */
+export async function isBillingEnabled(projectId) {
+  const { CloudBillingClient } = await import('@google-cloud/billing');
+  const client = new CloudBillingClient();
+  const projectName = `projects/${projectId}`;
+  try {
+    // getProjectBillingInfo requires cloudbilling.googleapis.com API to check billing status
+    // https://docs.cloud.google.com/billing/docs/reference/rest/v1/projects/getBillingInfo
+    const [billingInfo] = await client.getProjectBillingInfo({
+      name: projectName,
+    });
+    return billingInfo.billingEnabled;
+  } catch (error) {
+    console.error(
+      `Error checking billing status for project ${projectId}:`,
+      error.message || error
+    );
+    return false;
+  }
+}
+
+/**
+ * Ensures billing is enabled for a project. If not, attempts to enable it
+ * by attaching the single open billing account if one is found.
+ * @param {object} context - The context object containing clients and other parameters.
+ * @param {string} projectId The project ID to check billing for.
+ * @param {function} progressCallback A callback function for progress updates.
+ */
+export async function ensureBillingEnabled(
+  context,
+  projectId,
+  progressCallback
+) {
+  if (!(await isBillingEnabled(projectId))) {
+    // Billing is disabled, try to fix it.
+    const accounts = await listBillingAccounts();
+
+    if (accounts && accounts.length === 1 && accounts[0].open) {
+      // Exactly one open account found, try to attach it.
+      const account = accounts[0];
+      const attemptMessage = `Billing is not enabled for project ${projectId}. Found one open billing account: ${account.displayName} (${account.name}). Attempting to attach it...`;
+      console.log(attemptMessage);
+      if (progressCallback)
+        progressCallback({ level: 'info', data: attemptMessage });
+
+      const attachmentResult = await attachProjectToBillingAccount(
+        projectId,
+        account.name
+      );
+
+      if (!attachmentResult || !attachmentResult.billingEnabled) {
+        const attachFailMessage = `Failed to automatically attach project ${projectId} to billing account ${account.name}. Please enable billing manually: https://console.cloud.google.com/billing/linkedaccount?project=${projectId}`;
+        if (progressCallback)
+          progressCallback({ level: 'error', data: attachFailMessage });
+        throw new Error(attachFailMessage);
+      }
+      const attachSuccessMessage = `Successfully attached project ${projectId} to billing account ${account.name}.`;
+      console.log(attachSuccessMessage);
+      if (progressCallback)
+        progressCallback({ level: 'info', data: attachSuccessMessage });
+      // If we get here, billing is now enabled, and we can proceed to API checks.
+    } else {
+      // Cannot auto-attach. Throw error.
+      let reason;
+      if (!accounts || accounts.length === 0) {
+        reason = 'no billing accounts were found';
+      } else if (accounts.length > 1) {
+        reason = 'multiple billing accounts were found';
+      } else {
+        reason = `the only available billing account '${accounts[0].displayName}' is not open`;
+      }
+      const errorMessage = `Billing is not enabled for project ${projectId}, and it could not be enabled automatically because ${reason}. Please enable billing to use Google Cloud services: https://console.cloud.google.com/billing/linkedaccount?project=${projectId}`;
+      if (progressCallback)
+        progressCallback({ level: 'error', data: errorMessage });
+      throw new Error(errorMessage);
+    }
+  }
+}