MCP Tools Reference: managedkafka

Tool: `update_cluster`

Update an existing Google Cloud Managed service for Apache Kafka cluster. To update a cluster, please provide the Project ID, Location, and Cluster ID.

The following common parameters can be updated:

vCPU Count: The number of vCPUs to provision for the cluster (minimum 3). Please note that the vCPU count must be a string.
Memory Bytes: The memory to provision for the cluster in bytes (minimum 3 GiB, and the CPU:memory ratio must be between 1:1 and 1:8).
Rebalance Mode: The rebalancing behavior for the cluster. The options are NO_REBALANCE and AUTO_REBALANCE_ON_SCALE_UP.
Labels: Key-value pairs to help you organize your clusters.
Update Options: Options that influence how a cluster update is applied, such as allowBrokerDownscaleOnClusterUpscale.
Other parameters, like the TLS config, can also be set. The agent should also support these parameters.

This tool returns a long-running operation (LRO) that you can poll using the get_operation tool to track the cluster update status. Cluster updates can take 20 minutes or longer.

Important Notes:

CRITICAL: When calling update_cluster, the cluster object in your request MUST contain the cluster's full name, capacityConfig, and gcpConfig, even if you are not updating fields within them. The API requires these objects for validation on every update call. You should first get_cluster to retrieve these values before attempting an update.
The UpdateCluster request requires the following parameters:
- update_mask: A field mask used to specify the fields to be overwritten. For example, to update the cluster's memory and rebalance config, the mask would be "capacity_config.memory_bytes,rebalance_config.mode". A value of * will overwrite all fields.
- cluster: The cluster configuration, including the required capacity_config and gcp_config.
- cluster.name: The name of the cluster to be updated in the format projects/{project}/locations/{location}/clusters/{cluster}.
Do not update the cluster without getting all of the required parameters from the user.

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

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

Curl Request

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

Input Schema

Request for UpdateCluster.

UpdateClusterRequest

JSON representation
{ "updateMask": string, "cluster": { object (`Cluster`) }, "requestId": string }

Fields

Fields
`updateMask`	`string (FieldMask format)` Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields. This is a comma-separated list of fully qualified names of fields. Example: `"user.displayName,photo"`.
`cluster`	`object (Cluster)` Required. The cluster to update. Its `name` field must be populated.
`requestId`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request. The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

updateMask

string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

cluster

object (Cluster)

Required. The cluster to update. Its name field must be populated.

requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID to avoid duplication of requests. If a request times out or fails, retrying with the same ID allows the server to recognize the previous attempt. For at least 60 minutes, the server ignores duplicate requests bearing the same ID.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID within 60 minutes of the last request, the server checks if an original operation with the same request ID was received. If so, the server ignores the second request.

The request ID must be a valid UUID. A zero UUID is not supported (00000000-0000-0000-0000-000000000000).

FieldMask

JSON representation
{ "paths": [ string ] }

Fields

Fields
`paths[]`	`string` The set of field mask paths.

paths[]

string

The set of field mask paths.

Cluster

JSON representation

JSON representation
{ "name": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "capacityConfig": { object (`CapacityConfig`) }, "rebalanceConfig": { object (`RebalanceConfig`) }, "state": enum (`State`), "tlsConfig": { object (`TlsConfig`) }, "updateOptions": { object (`UpdateOptions`) }, "kafkaVersion": string, "brokerDetails": [ { object (`BrokerDetails`) } ], // Union field `platform_config` can be only one of the following: "gcpConfig": { object (`GcpConfig`) } // End of list of possible types for union field `platform_config`. // Union field `_satisfies_pzi` can be only one of the following: "satisfiesPzi": boolean // End of list of possible types for union field `_satisfies_pzi`. // Union field `_satisfies_pzs` can be only one of the following: "satisfiesPzs": boolean // End of list of possible types for union field `_satisfies_pzs`. }

{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "capacityConfig": {
    object (CapacityConfig)
  },
  "rebalanceConfig": {
    object (RebalanceConfig)
  },
  "state": enum (State),
  "tlsConfig": {
    object (TlsConfig)
  },
  "updateOptions": {
    object (UpdateOptions)
  },
  "kafkaVersion": string,
  "brokerDetails": [
    {
      object (BrokerDetails)
    }
  ],

  // Union field platform_config can be only one of the following:
  "gcpConfig": {
    object (GcpConfig)
  }
  // End of list of possible types for union field platform_config.

  // Union field _satisfies_pzi can be only one of the following:
  "satisfiesPzi": boolean
  // End of list of possible types for union field _satisfies_pzi.

  // Union field _satisfies_pzs can be only one of the following:
  "satisfiesPzs": boolean
  // End of list of possible types for union field _satisfies_pzs.
}

Fields
`name`	`string` Identifier. The name of the cluster. Structured like: projects/{project_number}/locations/{location}/clusters/{cluster_id}
`createTime`	`string (Timestamp format)` Output only. The time when the cluster 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. The time when the cluster was last 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"`.
`labels`	`map (key: string, value: string)` Optional. Labels as key value pairs. An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.
`capacityConfig`	`object (CapacityConfig)` Required. Capacity configuration for the Kafka cluster.
`rebalanceConfig`	`object (RebalanceConfig)` Optional. Rebalance configuration for the Kafka cluster.
`state`	`enum (State)` Output only. The current state of the cluster.
`tlsConfig`	`object (TlsConfig)` Optional. TLS configuration for the Kafka cluster.
`updateOptions`	`object (UpdateOptions)` Optional. UpdateOptions represents options that control how updates to the cluster are applied.
`kafkaVersion`	`string` Output only. Only populated when FULL view is requested. The Kafka version of the cluster.
`brokerDetails[]`	`object (BrokerDetails)` Output only. Only populated when FULL view is requested. Details of each broker in the cluster.
Union field `platform_config`. Platform specific configuration properties for a Kafka cluster. `platform_config` can be only one of the following:
`gcpConfig`	`object (GcpConfig)` Required. Configuration properties for a Kafka cluster deployed to Google Cloud Platform.
Union field `_satisfies_pzi`. `_satisfies_pzi` can be only one of the following:
`satisfiesPzi`	`boolean` Output only. Reserved for future use.
Union field `_satisfies_pzs`. `_satisfies_pzs` can be only one of the following:
`satisfiesPzs`	`boolean` Output only. Reserved for future use.

GcpConfig

JSON representation
{ "accessConfig": { object (`AccessConfig`) }, "kmsKey": string }

Fields

Fields
`accessConfig`	`object (AccessConfig)` Required. Access configuration for the Kafka cluster.
`kmsKey`	`string` Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

accessConfig

object (AccessConfig)

Required. Access configuration for the Kafka cluster.

kmsKey

string

Optional. Immutable. The Cloud KMS Key name to use for encryption. The key must be located in the same region as the cluster and cannot be changed. Structured like: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

AccessConfig

JSON representation
{ "networkConfigs": [ { object (`NetworkConfig`) } ] }

Fields

Fields
`networkConfigs[]`	`object (NetworkConfig)` Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka cluster. Minimum of 1 network is required. Maximum 10 networks can be specified.

networkConfigs[]

object (NetworkConfig)

Required. Virtual Private Cloud (VPC) networks that must be granted direct access to the Kafka cluster. Minimum of 1 network is required. Maximum 10 networks can be specified.

NetworkConfig

JSON representation
{ "subnet": string }

Fields

Fields
`subnet`	`string` Required. Name of the VPC subnet in which to create Private Service Connect (PSC) endpoints for the Kafka brokers and bootstrap address. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id} The subnet must be located in the same region as the Kafka cluster. The project may differ. Multiple subnets from the same parent network must not be specified.

subnet

string

Required. Name of the VPC subnet in which to create Private Service Connect (PSC) endpoints for the Kafka brokers and bootstrap address. Structured like: projects/{project}/regions/{region}/subnetworks/{subnet_id}

The subnet must be located in the same region as the Kafka cluster. The project may differ. Multiple subnets from the same parent network must not be specified.

Timestamp

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

Fields

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.

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`

CapacityConfig

JSON representation
{ "vcpuCount": string, "memoryBytes": string }

Fields

Fields
`vcpuCount`	`string (int64 format)` Required. The number of vCPUs to provision for the cluster. Minimum: 3.
`memoryBytes`	`string (int64 format)` Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB).

vcpuCount

string (int64 format)

Required. The number of vCPUs to provision for the cluster. Minimum: 3.

memoryBytes

string (int64 format)

Required. The memory to provision for the cluster in bytes. The CPU:memory ratio (vCPU:GiB) must be between 1:1 and 1:8. Minimum: 3221225472 (3 GiB).

RebalanceConfig

JSON representation
{ "mode": enum (`Mode`) }

Fields

Fields
`mode`	`enum (Mode)` Optional. The rebalance behavior for the cluster. When not specified, defaults to `NO_REBALANCE`.

mode

enum (Mode)

Optional. The rebalance behavior for the cluster. When not specified, defaults to NO_REBALANCE.

TlsConfig

JSON representation
{ "trustConfig": { object (`TrustConfig`) }, "sslPrincipalMappingRules": string }

Fields

Fields
`trustConfig`	`object (TrustConfig)` Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication.
`sslPrincipalMappingRules`	`string` Optional. A list of rules for mapping from SSL principal names to short names. These are applied in order by Kafka. Refer to the Apache Kafka documentation for `ssl.principal.mapping.rules` for the precise formatting details and syntax. Example: "RULE:^CN=(.?),OU=ServiceUsers.$/$1@example.com/,DEFAULT" This is a static Kafka broker configuration. Setting or modifying this field will trigger a rolling restart of the Kafka brokers to apply the change. An empty string means no rules are applied (Kafka default).

trustConfig

object (TrustConfig)

Optional. The configuration of the broker truststore. If specified, clients can use mTLS for authentication.

sslPrincipalMappingRules

string

Optional. A list of rules for mapping from SSL principal names to short names. These are applied in order by Kafka. Refer to the Apache Kafka documentation for ssl.principal.mapping.rules for the precise formatting details and syntax. Example: "RULE:^CN=(.*?),OU=ServiceUsers.*$/$1@example.com/,DEFAULT"

This is a static Kafka broker configuration. Setting or modifying this field will trigger a rolling restart of the Kafka brokers to apply the change. An empty string means no rules are applied (Kafka default).

TrustConfig

JSON representation
{ "casConfigs": [ { object (`CertificateAuthorityServiceConfig`) } ] }

Fields

Fields
`casConfigs[]`	`object (CertificateAuthorityServiceConfig)` Optional. Configuration for the Google Certificate Authority Service. Maximum 10.

casConfigs[]

object (CertificateAuthorityServiceConfig)

Optional. Configuration for the Google Certificate Authority Service. Maximum 10.

CertificateAuthorityServiceConfig

JSON representation
{ "caPool": string }

Fields

Fields
`caPool`	`string` Required. The name of the CA pool to pull CA certificates from. Structured like: projects/{project}/locations/{location}/caPools/{ca_pool}. The CA pool does not need to be in the same project or location as the Kafka cluster.

caPool

string

Required. The name of the CA pool to pull CA certificates from. Structured like: projects/{project}/locations/{location}/caPools/{ca_pool}. The CA pool does not need to be in the same project or location as the Kafka cluster.

UpdateOptions

JSON representation
{ "allowBrokerDownscaleOnClusterUpscale": boolean }

Fields

Fields
`allowBrokerDownscaleOnClusterUpscale`	`boolean` Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size.

allowBrokerDownscaleOnClusterUpscale

boolean

Optional. If true, allows an update operation that increases the total vCPU and/or memory allocation of the cluster to significantly decrease the per-broker vCPU and/or memory allocation. This can result in reduced performance and availability. By default, the update operation will fail if an upscale request results in a vCPU or memory allocation for the brokers that is smaller than 90% of the current broker size.

BrokerDetails

JSON representation

JSON representation
{ "rack": string, // Union field `_broker_index` can be only one of the following: "brokerIndex": string // End of list of possible types for union field `_broker_index`. // Union field `_node_id` can be only one of the following: "nodeId": string // End of list of possible types for union field `_node_id`. }

{
  "rack": string,

  // Union field _broker_index can be only one of the following:
  "brokerIndex": string
  // End of list of possible types for union field _broker_index.

  // Union field _node_id can be only one of the following:
  "nodeId": string
  // End of list of possible types for union field _node_id.
}

Fields

Fields
`rack`	`string` Output only. The rack of the broker.
Union field `_broker_index`. `_broker_index` can be only one of the following:
`brokerIndex`	`string (int64 format)` Output only. The index of the broker.
Union field `_node_id`. `_node_id` can be only one of the following:
`nodeId`	`string (int64 format)` Output only. The node id of the broker.

rack

string

Output only. The rack of the broker.

Union field _broker_index.

_broker_index can be only one of the following:

brokerIndex

string (int64 format)

Output only. The index of the broker.

Union field _node_id.

_node_id can be only one of the following:

nodeId

string (int64 format)

Output only. The node id of the broker.

Output Schema

This resource represents a long-running operation that is the result of a network API call.

Operation

JSON representation

JSON representation
{ "name": string, "metadata": { "@type": string, field1: ..., ... }, "done": boolean, // Union field `result` can be only one of the following: "error": { object (`Status`) }, "response": { "@type": string, field1: ..., ... } // End of list of possible types for union field `result`. }

{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // Union field result can be only one of the following:
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // End of list of possible types for union field result.
}

Fields
`name`	`string` The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
`metadata`	`object` Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`.
`done`	`boolean` If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
Union field `result`. The operation result, which can be either an `error` or a valid `response`. If `done` == `false`, neither `error` nor `response` is set. If `done` == `true`, exactly one of `error` or `response` can be set. Some services might not provide the result. `result` can be only one of the following:
`error`	`object (Status)` The error result of the operation in case of failure or cancellation.
`response`	`object` The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`.

Any

JSON representation
{ "typeUrl": string, "value": string }

Fields

Fields
`typeUrl`	`string` Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name. Example: type.googleapis.com/google.protobuf.StringValue This string must contain at least one `/` character, and the content after the last `/` must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them. The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last `/` to identify the type. `type.googleapis.com/` is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests. All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): `/-.~_!$&()*+,;=`. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, `type.googleapis.com%2FFoo` should be rejected. In the original design of `Any`, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.
`value`	`string (bytes format)` Holds a Protobuf serialization of the type described by type_url. A base64-encoded string.

typeUrl

string

Identifies the type of the serialized Protobuf message with a URI reference consisting of a prefix ending in a slash and the fully-qualified type name.

Example: type.googleapis.com/google.protobuf.StringValue

This string must contain at least one / character, and the content after the last / must be the fully-qualified name of the type in canonical form, without a leading dot. Do not write a scheme on these URI references so that clients do not attempt to contact them.

The prefix is arbitrary and Protobuf implementations are expected to simply strip off everything up to and including the last / to identify the type. type.googleapis.com/ is a common default prefix that some legacy implementations require. This prefix does not indicate the origin of the type, and URIs containing it are not expected to respond to any requests.

All type URL strings must be legal URI references with the additional restriction (for the text format) that the content of the reference must consist only of alphanumeric characters, percent-encoded escapes, and characters in the following set (not including the outer backticks): /-.~_!$&()*+,;=. Despite our allowing percent encodings, implementations should not unescape them to prevent confusion with existing parsers. For example, type.googleapis.com%2FFoo should be rejected.

In the original design of Any, the possibility of launching a type resolution service at these type URLs was considered but Protobuf never implemented one and considers contacting these URLs to be problematic and a potential security issue. Do not attempt to contact type URLs.

value

string (bytes format)

Holds a Protobuf serialization of the type described by type_url.

A base64-encoded string.

Status

JSON representation
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] }

Fields

Fields
`code`	`integer` The status code, which should be an enum value of `google.rpc.Code`.
`message`	`string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the `google.rpc.Status.details` field, or localized by the client.
`details[]`	`object` A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`.

code

integer

The status code, which should be an enum value of google.rpc.Code.

message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

Tool Annotations

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

MCP Tools Reference: managedkafka Stay organized with collections Save and categorize content based on your preferences.

Tool: update_cluster

Input Schema

UpdateClusterRequest

FieldMask

Cluster

GcpConfig

AccessConfig

NetworkConfig

Timestamp

LabelsEntry

CapacityConfig

RebalanceConfig

TlsConfig

TrustConfig

CertificateAuthorityServiceConfig

UpdateOptions

BrokerDetails

Output Schema

Operation

Any

Status

Tool Annotations

MCP Tools Reference: managedkafka

Tool: `update_cluster`