MCP Tools Reference: dataplex.googleapis.com

Tool: update_data_product

Initiates the update of a Data Product. * The update_mask parameter specifies which fields of the data product to update. For example, to update only the description field, set update_mask to description. To update multiple fields at once, separate the field names with commas. For example, description,labels updates both the description and labels fields. * The tool returns a long-running operation. Use the get_operation tool to poll its status until the operation completes. * The data product update operation can take several minutes. Use a command line tool to pause for 5 seconds before rechecking the status. * After you use the update_data_product tool, use the get_data_product tool to retrieve the current values of the data product fields.

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

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

Input Schema

Request message for updating a Data Product.

UpdateDataProductRequest

JSON representation 
{
  "parent": string,
  "dataProductId": string,
  "description": string,
  "ownerEmails": [
    string
  ],
  "accessGroups": {
    string: {
      object (AccessGroup)
    },
    ...
  },
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "updateMask": string
}
Fields
parent

string

Required. The parent resource where this data product will be created. Format: projects/{project_id_or_number}/locations/{location_id}
dataProductId

string

Required. The ID of the data product to create.

The ID must conform to RFC-1034 and contain only lower-case letters (a-z), numbers (0-9), or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum. Characters outside of ASCII are not permitted. Valid format regex: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$ If not provided, a system generated ID will be used.
description

string

Optional. The description of the data product.
ownerEmails[]

string

Optional. The emails of the data product owners.
accessGroups

map (key: string, value: object (AccessGroup))

Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.

Example:

{ "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" } } }

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

string

Optional. The display name of the data product.
labels

map (key: string, value: string)

Optional. Labels for the data product. Key/value pairs that can be attached to the data product.

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

string (FieldMask format)

Optional. The list of fields to update. If empty, all fields will be updated.

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

AccessGroupsEntry

JSON representation 
{
  "key": string,
  "value": {
    object (AccessGroup)
  }
}
Fields
key

string
value

object (AccessGroup)

AccessGroup

JSON representation 
{
  "id": string,
  "displayName": string,
  "description": string,
  "principal": {
    object (Principal)
  }
}
Fields
id

string

Required. Unique identifier of the access group within the data product. User defined. Eg. "analyst", "developer", etc.
displayName

string

Required. User friendly display name of the access group. Eg. "Analyst", "Developer", etc.
description

string

Optional. Description of the access group.
principal

object (Principal)

Required. The principal entity associated with this access group.

Principal

JSON representation 
{

  // Union field type can be only one of the following:
  "googleGroup": string
  // End of list of possible types for union field type.
}
Fields
Union field type. The type of the principal entity. type can be only one of the following:
googleGroup

string

Optional. Email of the Google Group, as per https://cloud.google.com/iam/docs/principals-overview#google-group.

LabelsEntry

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

string
value

string

FieldMask

JSON representation 
{
  "paths": [
    string
  ]
}
Fields
paths[]

string

The set of field mask paths.

Output Schema

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

Operation

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.
}
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
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
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: ❌