Tool: check_valid_creds
Check for valid credentials for a data source.
The following example shows a MCP call to check for valid credentials for a data source with the ID data_source_id
in the project myproject
in the location myregion
.
If the location isn't explicitly specified, and it can't be determined from the resources in the request, then the default location
is used. If the default location isn't set, then the job runs in the US
multi-region.
If has_valid_creds
is true, then the credentials are valid. Otherwise, the credentials are not valid.
check_valid_creds(project_id="myproject", location="myregion", data_source_id="mydatasource")
The following sample demonstrate how to use curl
to invoke the check_valid_creds
MCP tool.
| Curl Request |
|---|
curl --location 'https://bigquerydatatransfer.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "check_valid_creds", "arguments": { // provide these details according to the tool' s MCP specification } } , "jsonrpc" : "2.0" , "id" : 1 } ' |
Input Schema
A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
CheckValidCredsRequest
| JSON representation |
|---|
{ "name" : string } |
name
string
Required. The name of the data source. If you are using the regionless method, the location must be US
and the name should be in the following form:
-
projects/{project_id}/dataSources/{data_source_id}
If you are using the regionalized method, the name should be in the following form:
-
projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}
Output Schema
A response indicating whether the credentials exist and are valid.
CheckValidCredsResponse
| JSON representation |
|---|
{ "hasValidCreds" : boolean } |
| Fields | |
|---|---|
hasValidCreds
|
If set to |
Tool Annotations
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌
