Tools on MCP Toolbox for Databases

dataproc-get-cluster

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataproc-get-cluster tool retrieves a specific Dataproc cluster from a Google Cloud Dataproc source.

dataproc-get-cluster accepts the following parameters:

clusterName The short name of the cluster to retrieve. e.g. for projects/my-project/regions/us-central1/clusters/my-cluster, pass my-cluster.

The tool gets the project and region from the source configuration.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Dataproc Clusters Source

Example

kind: tool
name: get_cluster
type: dataproc-get-cluster
source: my-dataproc-source
description: Use this tool to get details of a Dataproc cluster.

Output Format

{
 "cluster": {
 "name": "projects/my-project/regions/us-central1/clusters/my-cluster",
 "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
 "state": "RUNNING",
 "createTime": "2023-10-27T10:00:00Z",
 },
 "consoleUrl": "https://console.cloud.google.com/dataproc/clusters/my-cluster/monitoring?region=us-central1&project=my-project",
 "logsUrl": "https://console.cloud.google.com/logs/viewer?advancedFilter=resource.type%3D%22cloud_dataproc_cluster%22%0Aresource.labels.project_id%3D%22my-project%22%0Aresource.labels.region%3D%22us-central1%22%0Aresource.labels.cluster_name%3D%22my-cluster%22%0Aresource.labels.cluster_uuid%3D%22a1b2c3d4-e5f6-7890-1234-567890abcdef%22&project=my-project&resource=cloud_dataproc_cluster%2Fcluster_name%2Fmy-cluster"
}

Reference

field	type	required	description
type	string	true	Must be “dataproc-get-cluster”.
source	string	true	Name of the source the tool should use.
description	string	true	Description of the tool that is passed to the LLM.
authRequired	string[]	false	List of auth services required to invoke this tool

dataproc-get-job

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataproc-get-job tool retrieves a specific Dataproc job from a Google Cloud Dataproc source.

dataproc-get-job accepts the following parameters:

jobId The job ID, e.g. for projects/my-project/regions/us-central1/jobs/my-job, pass my-job.

The tool gets the project and region from the source configuration.

Compatible Sources

This tool can be used with the following database sources:

Source Name
Dataproc Clusters Source

Example

kind: tool
name: get_job
type: dataproc-get-job
source: my-dataproc-source
description: Use this tool to get details of a Dataproc job.

Output Format

{
 "job": {
 "reference": {
 "projectId": "my-project",
 "jobId": "my-job"
 },
 "placement": {
 "clusterName": "my-cluster",
 "clusterUuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
 },
 ...
 },
 "consoleUrl": "https://console.cloud.google.com/dataproc/jobs/my-job?region=us-central1&project=my-project",
 "logsUrl": "https://console.cloud.google.com/logs/viewer?advancedFilter=resource.type%3D%22cloud_dataproc_cluster%22%0Aresource.labels.project_id%3D%22my-project%22%0Aresource.labels.region%3D%22us-central1%22%0Aresource.labels.cluster_name%3D%22my-cluster%22%0Alabels.job_id%3D%22my-job%22&project=my-project&resource=cloud_dataproc_cluster%2Fcluster_name%2Fmy-cluster"
}

Reference

field	type	required	description
type	string	true	Must be “dataproc-get-job”.
source	string	true	Name of the source the tool should use.
description	string	true	Description of the tool that is passed to the LLM.
authRequired	string[]	false	List of auth services required to invoke this tool

dataproc-list-clusters

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataproc-list-clusters tool returns a list of Dataproc clusters from a Google Cloud Dataproc source.

dataproc-list-clusters accepts the following parameters:

filter (optional): A filter expression to limit the clusters returned. Filters are case sensitive and may contain multiple clauses combined with logical operators (AND only). Supported fields are status.state, clusterName, and labels. For example: status.state = ACTIVE AND clusterName = mycluster. Supported status.state values are: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, STOPPED.
pageSize (optional): The maximum number of clusters to return in a single page.
pageToken (optional): A page token, received from a previous call, to retrieve the next page of results. Defaults to 20.

The tool gets the project and region from the source configuration.

dataproc-list-jobs

Mon, 01 Jan 0001 00:00:00 +0000

About

A dataproc-list-jobs tool returns a list of Dataproc jobs from a Google Cloud Dataproc source.

dataproc-list-jobs accepts the following parameters:

filter (optional): A filter expression to limit the jobs returned. Filters are case sensitive and may contain multiple clauses combined with logical operators (AND only). Supported fields are status.state and labels. For example: status.state = RUNNING AND labels.env = production. Supported status.state values are: PENDING, RUNNING, CANCEL_PENDING, JOB_STATE_CANCELLED, DONE, ERROR, ATTEMPT_FAILURE.
jobStateMatcher (optional): Specifies if the job state matcher should match ALL jobs, only ACTIVE jobs, or only NON_ACTIVE jobs. Defaults to ALL. Supported values: ALL, ACTIVE, NON_ACTIVE.
pageSize (optional): The maximum number of jobs to return in a single page.
pageToken (optional): A page token, received from a previous call, to retrieve the next page of results.

The tool gets the project and region from the source configuration.