MCP Tools Reference: aiplatform.googleapis.com

Tool: colab_enterprise_get_notebook_runtime

Gets the details of a Colab Enterprise notebook runtime. Use this tool to retrieve information about a specific notebook runtime, such as its state or configuration, using its resource name.

The following sample demonstrate how to use curl to invoke the colab_enterprise_get_notebook_runtime MCP tool.

Curl Request 
                  
curl --location 'https://aiplatform.googleapis.com/mcp/generate' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "colab_enterprise_get_notebook_runtime",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Input Schema

Request message for NotebookService.GetNotebookRuntime

GetNotebookRuntimeRequest

JSON representation 
{
  "name": string
}
Fields
name

string

Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.

Output Schema

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime. Default runtimes have a lifetime of 18 hours, while custom runtimes last for 6 months from their creation or last upgrade.

NotebookRuntime

JSON representation 
{
  "name": string,
  "runtimeUser": string,
  "notebookRuntimeTemplateRef": {
    object (NotebookRuntimeTemplateRef)
  },
  "proxyUri": string,
  "createTime": string,
  "updateTime": string,
  "healthState": enum (HealthState),
  "displayName": string,
  "description": string,
  "serviceAccount": string,
  "runtimeState": enum (RuntimeState),
  "isUpgradable": boolean,
  "labels": {
    string: string,
    ...
  },
  "expirationTime": string,
  "version": string,
  "notebookRuntimeType": enum (NotebookRuntimeType),
  "machineSpec": {
    object (MachineSpec)
  },
  "dataPersistentDiskSpec": {
    object (PersistentDiskSpec)
  },
  "networkSpec": {
    object (NetworkSpec)
  },
  "idleShutdownConfig": {
    object (NotebookIdleShutdownConfig)
  },
  "eucConfig": {
    object (NotebookEucConfig)
  },
  "shieldedVmConfig": {
    object (ShieldedVmConfig)
  },
  "networkTags": [
    string
  ],
  "softwareConfig": {
    object (NotebookSoftwareConfig)
  },
  "encryptionSpec": {
    object (EncryptionSpec)
  },
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Fields
name

string

Output only. The resource name of the NotebookRuntime.
runtimeUser

string

Required. The user email of the NotebookRuntime.
notebookRuntimeTemplateRef

object (NotebookRuntimeTemplateRef)

Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
proxyUri

string

Output only. The proxy endpoint used to access the NotebookRuntime.
createTime

string (Timestamp format)

Output only. Timestamp when this NotebookRuntime was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Timestamp when this NotebookRuntime was most recently updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
healthState

enum (HealthState)

Output only. The health state of the NotebookRuntime.
displayName

string

Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
description

string

The description of the NotebookRuntime.
serviceAccount

string

Output only. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details.

The service account that the NotebookRuntime workload runs as.
runtimeState

enum (RuntimeState)

Output only. The runtime (instance) state of the NotebookRuntime.
isUpgradable

boolean

Output only. Whether NotebookRuntime is upgradable.
labels

map (key: string, value: string)

The labels with user-defined metadata to organize your NotebookRuntime.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime:

  • "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id.
  • "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
expirationTime

string (Timestamp format)

Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
version

string

Output only. The VM os image version of NotebookRuntime.
notebookRuntimeType

enum (NotebookRuntimeType)

Output only. The type of the notebook runtime.
machineSpec

object (MachineSpec)

Output only. The specification of a single machine used by the notebook runtime.
dataPersistentDiskSpec

object (PersistentDiskSpec)

Output only. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the notebook runtime as data disk storage.
networkSpec

object (NetworkSpec)

Output only. Network spec of the notebook runtime.
idleShutdownConfig

object (NotebookIdleShutdownConfig)

Output only. The idle shutdown configuration of the notebook runtime.
eucConfig

object (NotebookEucConfig)

Output only. EUC configuration of the notebook runtime.
shieldedVmConfig

object (ShieldedVmConfig)

Output only. Runtime Shielded VM spec.
networkTags[]

string

Optional. The Compute Engine tags to add to runtime (see Tagging instances).
softwareConfig

object (NotebookSoftwareConfig)

Output only. Software config of the notebook runtime.
encryptionSpec

object (EncryptionSpec)

Output only. Customer-managed encryption key spec for the notebook runtime.
satisfiesPzs

boolean

Output only. Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future use.

NotebookRuntimeTemplateRef

JSON representation 
{
  "notebookRuntimeTemplate": string
}
Fields
notebookRuntimeTemplate

string

Immutable. A resource name of the NotebookRuntimeTemplate.

Timestamp

JSON representation 
{
  "seconds": string,
  "nanos": integer
}
Fields
seconds

string (int64 format)

Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
nanos

integer

Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

LabelsEntry

JSON representation 
{
  "key": string,
  "value": string
}
Fields
key

string
value

string

MachineSpec

JSON representation 
{
  "machineType": string,
  "acceleratorType": enum (AcceleratorType),
  "acceleratorCount": integer,
  "gpuPartitionSize": string,
  "tpuTopology": string,
  "reservationAffinity": {
    object (ReservationAffinity)
  }
}
Fields
machineType

string

Immutable. The type of the machine.

See the list of machine types supported for prediction

See the list of machine types supported for custom training.

For DeployedModel this field is optional, and the default value is n1-standard-2. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.
acceleratorType

enum (AcceleratorType)

Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
acceleratorCount

integer

The number of accelerators to attach to the machine.

For accelerator optimized machine types (https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Vertex will co-schedule the replicas of the model into the same VM to save cost.

For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Vertex will co-schedule 8, 4, 2, or 2 replicas of the model into the same VM to save cost.

When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM.

Note that the feature is not compatible with [multihost_gpu_node_count][]. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.
gpuPartitionSize

string

Optional. Immutable. The Nvidia GPU partition size.

When specified, the requested accelerators will be partitioned into smaller GPU partitions. For example, if the request is for 8 units of NVIDIA A100 GPUs, and gpu_partition_size="1g.10gb", the service will create 8 * 7 = 56 partitioned MIG instances.

The partition size must be a value supported by the requested accelerator. Refer to Nvidia GPU Partitioning for the available partition sizes.

If set, the accelerator_count should be set to 1.
tpuTopology

string

Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
reservationAffinity

object (ReservationAffinity)

Optional. Immutable. Configuration controlling how this resource pool consumes reservation.

ReservationAffinity

JSON representation 
{
  "reservationAffinityType": enum (Type),
  "key": string,
  "values": [
    string
  ]
}
Fields
reservationAffinityType

enum (Type)

Required. Specifies the reservation affinity type.
key

string

Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.
values[]

string

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation or reservation block.

PersistentDiskSpec

JSON representation 
{
  "diskType": string,
  "diskSizeGb": string
}
Fields
diskType

string

Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk)
diskSizeGb

string (int64 format)

Size in GB of the disk (default is 100GB).

NetworkSpec

JSON representation 
{
  "enableInternetAccess": boolean,
  "network": string,
  "subnetwork": string
}
Fields
enableInternetAccess

boolean

Whether to enable public internet access. Default false.
network

string

The full name of the Google Compute Engine network
subnetwork

string

The name of the subnet that this instance is in. Format: projects/{project_id_or_number}/regions/{region}/subnetworks/{subnetwork_id}

NotebookIdleShutdownConfig

JSON representation 
{
  "idleTimeout": string,
  "idleShutdownDisabled": boolean
}
Fields
idleTimeout

string (Duration format)

Required. Duration is accurate to the second. In Notebook, Idle Timeout is accurate to minute so the range of idle_timeout (second) is: 10 * 60 ~ 1440 * 60.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
idleShutdownDisabled

boolean

Whether Idle Shutdown is disabled in this NotebookRuntimeTemplate.

Duration

JSON representation 
{
  "seconds": string,
  "nanos": integer
}
Fields
seconds

string (int64 format)

Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos

integer

Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 seconds field and a positive or negative nanos field. For durations of one second or more, a non-zero value for the nanos field must be of the same sign as the seconds field. Must be from -999,999,999 to +999,999,999 inclusive.

NotebookEucConfig

JSON representation 
{
  "eucDisabled": boolean,
  "bypassActasCheck": boolean
}
Fields
eucDisabled

boolean

Input only. Whether EUC is disabled in this NotebookRuntimeTemplate. In proto3, the default value of a boolean is false. In this way, by default EUC will be enabled for NotebookRuntimeTemplate.
bypassActasCheck

boolean

Output only. Whether ActAs check is bypassed for service account attached to the VM. If false, we need ActAs check for the default Compute Engine Service account. When a Runtime is created, a VM is allocated using Default Compute Engine Service Account. Any user requesting to use this Runtime requires Service Account User (ActAs) permission over this SA. If true, Runtime owner is using EUC and does not require the above permission as VM no longer use default Compute Engine SA, but a P4SA.

ShieldedVmConfig

JSON representation 
{
  "enableSecureBoot": boolean
}
Fields
enableSecureBoot

boolean

Defines whether the instance has Secure Boot enabled.

Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.

NotebookSoftwareConfig

JSON representation 
{
  "env": [
    {
      object (EnvVar)
    }
  ],
  "postStartupScriptConfig": {
    object (PostStartupScriptConfig)
  },

  // Union field runtime_image can be only one of the following:
  "colabImage": {
    object (ColabImage)
  }
  // End of list of possible types for union field runtime_image.
}
Fields
env[]

object (EnvVar)

Optional. Environment variables to be passed to the container. Maximum limit is 100.
postStartupScriptConfig

object (PostStartupScriptConfig)

Optional. Post startup script config.

Union field runtime_image.

runtime_image can be only one of the following:
colabImage

object (ColabImage)

Optional. Google-managed NotebookRuntime colab image.

ColabImage

JSON representation 
{
  "releaseName": string,
  "description": string
}
Fields
releaseName

string

Optional. The release name of the NotebookRuntime Colab image, e.g. "py310". If not specified, detault to the latest release.
description

string

Output only. A human-readable description of the specified colab image release, populated by the system. Example: "Python 3.10", "Latest - current Python 3.11"

EnvVar

JSON representation 
{
  "name": string,
  "value": string
}
Fields
name

string

Required. Name of the environment variable. Must be a valid C identifier.
value

string

Required. Variables that reference a $(VAR_NAME) are expanded using the previous defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.

PostStartupScriptConfig

JSON representation 
{
  "postStartupScript": string,
  "postStartupScriptUrl": string,
  "postStartupScriptBehavior": enum (PostStartupScriptBehavior)
}
Fields
postStartupScript

string

Optional. Post startup script to run after runtime is started.
postStartupScriptUrl

string

Optional. Post startup script url to download. Example: gs://bucket/script.sh
postStartupScriptBehavior

enum (PostStartupScriptBehavior)

Optional. Post startup script behavior that defines download and execution behavior.

EncryptionSpec

JSON representation 
{
  "kmsKeyName": string
}
Fields
kmsKeyName

string

Required. Resource name of the Cloud KMS key used to protect the resource.

The Cloud KMS key must be in the same region as the resource. It must have the format projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Tool Annotations

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌