Set up and configure settings

This document describes how to configure initial settings after you install the Google Cloud Data Agent Kit extension for Visual Studio Code.

Before you begin

Before you begin, complete the steps on Install the extension.

Configure Google Cloud project and region

If you haven't configured your project and region, take the following steps.

  1. To open the Data Cloud Settings editor, click the Google Cloud Data Agent Kit icon in the activity bar.
  2. Expand Settings, and then click Settings.
  3. Select Common.
  4. Select your Project ID and Region. The project ID must match the project ID that you specified in the gcloud CLI.
  5. Click Save.

Review required roles

  1. To open the Data Cloud Settings editor, click the Google Cloud Data Agent Kit icon in the activity bar.
  2. Expand Settings, and then click Settings.
  3. Navigate to Common > Required Permissions.

    The Access column indicates whether you are a principal in a required role.

  4. To get any missing permissions that you need to use the Data Agent Kit extension for VS Code, ask your administrator to grant you the corresponding Identity and Access Management (IAM) roles on the project. For more information about granting roles, see Manage access to projects, folders, and organizations.

Configure BigQuery region

  1. To open the Data Cloud Settings editor, click the Google Cloud Data Agent Kit icon in the activity bar.
  2. Expand Settings, and then click Settings.
  3. Select BigQuery.
  4. Select a BigQuery region.
  5. Click Save.

View Serverless Runtimes for Apache Spark

  1. To open the Data Cloud Settings editor, click the Google Cloud Data Agent Kit icon in the activity bar.
  2. Expand Settings, and then click Settings.
  3. Select Apache Spark. All serverless runtimes for your project are displayed.
  4. To view a serverless runtime configuration, click its name.

Create a Serverless Runtime for Apache Spark

  1. To open the Data Cloud Settings editor, click the Google Cloud Data Agent Kit icon in the activity bar.
  2. Expand Settings, and then click Settings.
  3. Select Apache Spark.
  4. Click Create.
  5. Fill in the fields and then click Save.

Delete a Serverless Runtime for Apache Spark

  1. To open the Data Cloud Settings editor, click the Google Cloud Data Agent Kit icon in the activity bar.
  2. Expand Settings, and then click Settings.
  3. Select Apache Spark.
  4. For the serverless runtime that you want to delete, click Actions and then click Delete.

Set up Scheduler

  1. To open the Google Cloud Data Agent Kit Settings editor, click the Google Cloud Data Agent Kit icon in the activity bar.
  2. Expand Settings, and then click Settings.
  3. Click Scheduler.
  4. Select a project and region. The project and region don't need to match the project and region you selected on the Common tab.
  5. Select a Managed Service for Apache Airflow Environment environment to set up workflows.
  6. Click Save.

Review agent skills

The Data Agent Kit extension for VS Code comes with agent skills that you can use in your workflows.

  1. To open the Data Cloud Settings editor, click the Google Cloud Data Agent Kit icon in the activity bar.
  2. Expand Settings, and then click Settings.
  3. Click Skills.
  4. To read the Markdown that defines a skill, click the skill title.

Install dependencies

Some Google Cloud Data Agent Kit operations require you to install additional software after you've installed the extension. In some cases, you are prompted to consent to automatic installation. In other cases you must manually install the software.

Orchestration Pipelines

To work with Orchestration Pipelines in your IDE, install the following:

Notebooks

When you attempt an operation that requires the following, the IDE prompts you for your consent and then installs the software for you:

  • BigQuery DataFrames (version 2.36 or later)
  • Anywidget
  • BigQuery ML

To allow the agent to execute code cells in your notebooks, you can enable the google.datacloud.executeCellToolForNotebookMCP setting in your IDE settings. This setting enables the execute_cell tool for the Notebook Model Context Protocol (MCP).

Troubleshoot

If you run into issues, try signing out of Google Cloud Data Agent Kit and the gcloud CLI and then signing in again. To find additional methods for diagnosing and resolving configuration errors, see Troubleshoot the Data Agent Kit extension for VS Code.

Report an issue

To report an issue, do the following:

  1. In the Google Cloud Data Agent Kit menu in the activity bar, click Report bug.
  2. In the form that opens, document the issue and click Submit.

What's next