MCP Tools Reference: apihub.googleapis.com

Tool: list_external_apis

List External API resources in the API hub.

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

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

Input Schema

The ListExternalApis method's request.

ListExternalApisRequest

JSON representation 
{
  "parent": string,
  "pageSize": integer,
  "pageToken": string
}
Fields
parent

string

Required. The parent, which owns this collection of External API resources. Format: projects/{project}/locations/{location}
pageSize

integer

Optional. The maximum number of External API resources to return. The service may return fewer than this value. If unspecified, at most 50 ExternalApis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous ListExternalApis call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListExternalApis must match the call that provided the page token.

Output Schema

The ListExternalApis method's response.

ListExternalApisResponse

JSON representation 
{
  "externalApis": [
    {
      object (ExternalApi)
    }
  ],
  "nextPageToken": string
}
Fields
externalApis[]

object (ExternalApi)

The External API resources present in the API hub.
nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ExternalApi

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "endpoints": [
    string
  ],
  "paths": [
    string
  ],
  "documentation": {
    object (Documentation)
  },
  "attributes": {
    string: {
      object (AttributeValues)
    },
    ...
  },
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. Format: projects/{project}/locations/{location}/externalApi/{externalApi}.
displayName

string

Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
description

string

Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
endpoints[]

string

Optional. List of endpoints on which this API is accessible.
paths[]

string

Optional. List of paths served by this API.
documentation

object (Documentation)

Optional. Documentation of the external API.
attributes

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

Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute}. The value is the attribute values associated with the resource.

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

string (Timestamp format)

Output only. Creation timestamp.

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. Last update timestamp.

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".

Documentation

JSON representation 
{
  "externalUri": string
}
Fields
externalUri

string

Optional. The uri of the externally hosted documentation.

AttributesEntry

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

string
value

object (AttributeValues)

AttributeValues

JSON representation 
{
  "attribute": string,

  // Union field Value can be only one of the following:
  "enumValues": {
    object (EnumAttributeValues)
  },
  "stringValues": {
    object (StringAttributeValues)
  },
  "jsonValues": {
    object (StringAttributeValues)
  },
  "uriValues": {
    object (StringAttributeValues)
  }
  // End of list of possible types for union field Value.
}
Fields
attribute

string

Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
Union field Value. The attribute values associated with the resource. Value can be only one of the following:
enumValues

object (EnumAttributeValues)

The attribute values associated with a resource in case attribute data type is enum.
stringValues

object (StringAttributeValues)

The attribute values associated with a resource in case attribute data type is string.
jsonValues

object (StringAttributeValues)

The attribute values associated with a resource in case attribute data type is JSON.
uriValues

object (StringAttributeValues)

The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.

EnumAttributeValues

JSON representation 
{
  "values": [
    {
      object (AllowedValue)
    }
  ]
}
Fields
values[]

object (AllowedValue)

Required. The attribute values in case attribute data type is enum.

AllowedValue

JSON representation 
{
  "id": string,
  "displayName": string,
  "description": string,
  "immutable": boolean
}
Fields
id

string

Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
displayName

string

Required. The display name of the allowed value.
description

string

Optional. The detailed description of the allowed value.
immutable

boolean

Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.

StringAttributeValues

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

string

Required. The attribute values in case attribute data type is string or JSON.

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.

Tool Annotations

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