googleapis
Version:
Google APIs Client Library for Node.js
1,171 lines • 224 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace agentregistry_v1alpha {
export interface Options extends GlobalOptions {
version: 'v1alpha';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Agent Registry API
*
* Agent Registry is a centralized, unified catalog that lets you store, discover, and govern Model Context Protocol (MCP) servers, tools, and AI agents within Google Cloud.
*
* @example
* ```js
* const {google} = require('googleapis');
* const agentregistry = google.agentregistry('v1alpha');
* ```
*/
export class Agentregistry {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Represents the skills of an Agent.
*/
export interface Schema$A2ASkill {
/**
* Output only. A more detailed description of the skill.
*/
description?: string | null;
/**
* Output only. Example prompts or scenarios this skill can handle.
*/
examples?: string[] | null;
/**
* Output only. A unique identifier for the agent's skill.
*/
id?: string | null;
/**
* Output only. A human-readable name for the agent's skill.
*/
name?: string | null;
/**
* Output only. Keywords describing the skill.
*/
tags?: string[] | null;
}
/**
* Represents an Agent. "A2A" below refers to the Agent-to-Agent protocol.
*/
export interface Schema$Agent {
/**
* Output only. A stable, globally unique identifier for agents.
*/
agentId?: string | null;
/**
* Output only. Attributes of the Agent. Valid values: * `agentregistry.googleapis.com/system/Framework`: {"framework": "google-adk"\} - the agent framework used to develop the Agent. Example values: "google-adk", "langchain", "custom". * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."\} - the runtime identity associated with the Agent. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."\} - the URI of the underlying resource hosting the Agent, for example, the Reasoning Engine URI.
*/
attributes?: {
[key: string]: {
[key: string]: any;
};
} | null;
/**
* Output only. Full Agent Card payload, when available.
*/
card?: Schema$Card;
/**
* Output only. Create time.
*/
createTime?: string | null;
/**
* Output only. The description of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no description.
*/
description?: string | null;
/**
* Output only. The display name of the agent, often obtained from the A2A Agent Card.
*/
displayName?: string | null;
/**
* Output only. The location where agent is hosted. The value is defined by the hosting environment (i.e. cloud provider).
*/
location?: string | null;
/**
* Identifier. The resource name of an Agent. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`.
*/
name?: string | null;
/**
* Output only. The connection details for the Agent.
*/
protocols?: Schema$Protocol[];
/**
* Output only. Skills the agent possesses, often obtained from the A2A Agent Card.
*/
skills?: Schema$A2ASkill[];
/**
* Output only. A universally unique identifier for the Agent.
*/
uid?: string | null;
/**
* Output only. Update time.
*/
updateTime?: string | null;
/**
* Output only. The version of the Agent, often obtained from the A2A Agent Card. Empty if Agent Card has no version or agent is not an A2A Agent.
*/
version?: string | null;
}
/**
* The spec of the agent.
*/
export interface Schema$AgentSpec {
/**
* Optional. The content of the Agent spec in the JSON format. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
*/
content?: {
[key: string]: any;
} | null;
/**
* Required. The type of the agent spec content.
*/
type?: string | null;
}
/**
* Annotations describing the characteristics and behavior of a tool or operation.
*/
export interface Schema$Annotations {
/**
* Output only. If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. NOTE: This property is meaningful only when `read_only_hint == false` Default: true
*/
destructiveHint?: boolean | null;
/**
* Output only. If true, calling the tool repeatedly with the same arguments will have no additional effect on its environment. NOTE: This property is meaningful only when `read_only_hint == false` Default: false
*/
idempotentHint?: boolean | null;
/**
* Output only. If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. Default: true
*/
openWorldHint?: boolean | null;
/**
* Output only. If true, the tool does not modify its environment. Default: false
*/
readOnlyHint?: boolean | null;
/**
* Output only. A human-readable title for the tool.
*/
title?: string | null;
}
/**
* Direct write-only raw archive payload upload.
*/
export interface Schema$ArchiveUploadSource {
/**
* Required. Input only. Write-only raw ZIP/TAR archive payload bytes containing the skill package.
*/
archiveContent?: string | null;
}
/**
* The AuthProvider of the Binding.
*/
export interface Schema$AuthProviderBinding {
/**
* Required. The resource name of the target AuthProvider. Format: * `projects/{project\}/locations/{location\}/authProviders/{auth_provider\}`
*/
authProvider?: string | null;
/**
* Optional. The continue URI of the AuthProvider. The URI is used to reauthenticate the user and finalize the managed OAuth flow.
*/
continueUri?: string | null;
/**
* Optional. The list of OAuth2 scopes of the AuthProvider.
*/
scopes?: string[] | null;
}
/**
* Represents a user-defined Binding.
*/
export interface Schema$Binding {
/**
* The binding for AuthProvider.
*/
authProviderBinding?: Schema$AuthProviderBinding;
/**
* Output only. Timestamp when this binding was created.
*/
createTime?: string | null;
/**
* Optional. User-defined description of a Binding. Can have a maximum length of `2048` characters.
*/
description?: string | null;
/**
* Optional. User-defined display name for the Binding. Can have a maximum length of `63` characters.
*/
displayName?: string | null;
/**
* Required. Identifier. The resource name of the Binding. Format: `projects/{project\}/locations/{location\}/bindings/{binding\}`.
*/
name?: string | null;
/**
* Required. The target Agent of the Binding.
*/
source?: Schema$Source;
/**
* Required. The target Agent Registry Resource of the Binding.
*/
target?: Schema$Target;
/**
* Output only. Timestamp when this binding was last updated.
*/
updateTime?: string | null;
}
/**
* The request message for Operations.CancelOperation.
*/
export interface Schema$CancelOperationRequest {
}
/**
* Full Agent Card payload, often obtained from the A2A Agent Card.
*/
export interface Schema$Card {
/**
* Output only. The content of the agent card.
*/
content?: {
[key: string]: any;
} | null;
/**
* Output only. The type of agent card.
*/
type?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* Represents an Endpoint.
*/
export interface Schema$Endpoint {
/**
* Output only. Attributes of the Endpoint. Valid values: * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."\} - the URI of the underlying resource hosting the Endpoint, for example, the GKE Deployment.
*/
attributes?: {
[key: string]: {
[key: string]: any;
};
} | null;
/**
* Output only. Create time.
*/
createTime?: string | null;
/**
* Output only. Description of an Endpoint.
*/
description?: string | null;
/**
* Output only. Display name for the Endpoint.
*/
displayName?: string | null;
/**
* Output only. A stable, globally unique identifier for Endpoint.
*/
endpointId?: string | null;
/**
* Required. The connection details for the Endpoint.
*/
interfaces?: Schema$Interface[];
/**
* Identifier. The resource name of the Endpoint. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}`.
*/
name?: string | null;
/**
* Output only. Update time.
*/
updateTime?: string | null;
}
/**
* The spec of the endpoint.
*/
export interface Schema$EndpointSpec {
/**
* Optional. The content of the endpoint spec. Reserved for future use.
*/
content?: {
[key: string]: any;
} | null;
/**
* Required. The type of the endpoint spec content.
*/
type?: string | null;
}
/**
* Message for response to fetching available Bindings.
*/
export interface Schema$FetchAvailableBindingsResponse {
/**
* The list of Bindings.
*/
bindings?: Schema$Binding[];
/**
* A token identifying a page of results the server should return.
*/
nextPageToken?: string | null;
}
/**
* Structured metadata attributes extracted from the package's local SKILL.md frontmatter.
*/
export interface Schema$Frontmatter {
/**
* Optional. Environmental dependencies or local sidecars.
*/
compatibility?: string | null;
/**
* Required. Functional description.
*/
description?: string | null;
/**
* Optional. License.
*/
license?: string | null;
/**
* Optional. Extensible flattened map mapping custom tags, authors, and version parameters.
*/
metadata?: {
[key: string]: string;
} | null;
/**
* Required. The name of the skill.
*/
name?: string | null;
}
/**
* Specifications for Cloud Storage objects.
*/
export interface Schema$GcsSource {
/**
* Optional. Cloud Storage object generation ID. If not specified, the latest generation is used.
*/
generation?: string | null;
/**
* Required. Cloud Storage object URI. Format: `gs://{bucket_name\}/{object_name\}`
*/
uri?: string | null;
}
/**
* Represents the connection details for an Agent or MCP Server.
*/
export interface Schema$Interface {
/**
* Required. The protocol binding of the interface.
*/
protocolBinding?: string | null;
/**
* Required. The destination URL.
*/
url?: string | null;
}
/**
* Message for response to listing Agents
*/
export interface Schema$ListAgentsResponse {
/**
* The list of Agents.
*/
agents?: Schema$Agent[];
/**
* A token identifying a page of results the server should return.
*/
nextPageToken?: string | null;
}
/**
* Message for response to listing Bindings
*/
export interface Schema$ListBindingsResponse {
/**
* The list of Binding resources matching the parent and filter criteria in the request. Each Binding resource follows the format: `projects/{project\}/locations/{location\}/bindings/{binding\}`.
*/
bindings?: Schema$Binding[];
/**
* A token identifying a page of results the server should return. Used in page_token.
*/
nextPageToken?: string | null;
}
/**
* Message for response to listing Endpoints
*/
export interface Schema$ListEndpointsResponse {
/**
* The list of Endpoint resources matching the parent and filter criteria in the request. Each Endpoint resource follows the format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}`.
*/
endpoints?: Schema$Endpoint[];
/**
* A token identifying a page of results the server should return. Used in page_token.
*/
nextPageToken?: string | null;
}
/**
* The response message for Locations.ListLocations.
*/
export interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
}
/**
* Message for response to listing McpServers
*/
export interface Schema$ListMcpServersResponse {
/**
* The list of McpServers.
*/
mcpServers?: Schema$McpServer[];
/**
* A token identifying a page of results the server should return.
*/
nextPageToken?: string | null;
}
/**
* The response message for Operations.ListOperations.
*/
export interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string | null;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
/**
* Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
*/
unreachable?: string[] | null;
}
/**
* Response listing Publishers.
*/
export interface Schema$ListPublishersResponse {
/**
* Page offset continuation token.
*/
nextPageToken?: string | null;
/**
* The returned list of Publishers.
*/
publishers?: Schema$Publisher[];
}
/**
* Message for response to listing Services
*/
export interface Schema$ListServicesResponse {
/**
* A token identifying a page of results the server should return. Used in page_token.
*/
nextPageToken?: string | null;
/**
* The list of Service resources matching the parent and filter criteria in the request. Each Service resource follows the format: `projects/{project\}/locations/{location\}/services/{service\}`.
*/
services?: Schema$Service[];
}
/**
* Response listing Revisions.
*/
export interface Schema$ListSkillRevisionsResponse {
/**
* Page offset continuation token.
*/
nextPageToken?: string | null;
/**
* Returned version snapshot list.
*/
skillRevisions?: Schema$SkillRevision[];
}
/**
* Response structure listing logical Skills.
*/
export interface Schema$ListSkillsResponse {
/**
* Page continuation continuation token.
*/
nextPageToken?: string | null;
/**
* Returned container list.
*/
skills?: Schema$Skill[];
/**
* Unreachable locations or failures.
*/
unreachable?: string[] | null;
}
/**
* A resource that represents a Google Cloud location.
*/
export interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For example, "Tokyo".
*/
displayName?: string | null;
/**
* Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\}
*/
labels?: {
[key: string]: string;
} | null;
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string | null;
/**
* Service-specific metadata. For example the available capacity at the given location.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
*/
name?: string | null;
}
/**
* Represents an MCP (Model Context Protocol) Server.
*/
export interface Schema$McpServer {
/**
* Output only. Attributes of the MCP Server. Valid values: * `agentregistry.googleapis.com/system/RuntimeIdentity`: {"principal": "principal://..."\} - the runtime identity associated with the MCP Server. * `agentregistry.googleapis.com/system/RuntimeReference`: {"uri": "//..."\} - the URI of the underlying resource hosting the MCP Server, for example, the GKE Deployment.
*/
attributes?: {
[key: string]: {
[key: string]: any;
};
} | null;
/**
* Output only. Create time.
*/
createTime?: string | null;
/**
* Output only. The description of the MCP Server.
*/
description?: string | null;
/**
* Output only. The display name of the MCP Server.
*/
displayName?: string | null;
/**
* Output only. The connection details for the MCP Server.
*/
interfaces?: Schema$Interface[];
/**
* Output only. A stable, globally unique identifier for MCP Servers.
*/
mcpServerId?: string | null;
/**
* Identifier. The resource name of the MCP Server. Format: `projects/{project\}/locations/{location\}/mcpServers/{mcp_server\}`.
*/
name?: string | null;
/**
* Output only. Tools provided by the MCP Server.
*/
tools?: Schema$Tool[];
/**
* Output only. Update time.
*/
updateTime?: string | null;
}
/**
* The spec of the MCP Server.
*/
export interface Schema$McpServerSpec {
/**
* Optional. The content of the MCP Server spec. This payload is validated against the schema for the specified type. The content size is limited to `10KB`.
*/
content?: {
[key: string]: any;
} | null;
/**
* Required. The type of the MCP Server spec content.
*/
type?: string | null;
}
/**
* This resource represents a long-running operation that is the result of a network API call.
*/
export interface Schema$Operation {
/**
* 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.
*/
done?: boolean | null;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* 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.
*/
metadata?: {
[key: string]: any;
} | null;
/**
* 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\}`.
*/
name?: string | null;
/**
* 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`.
*/
response?: {
[key: string]: any;
} | null;
}
/**
* Represents the metadata of the long-running operation.
*/
export interface Schema$OperationMetadata {
/**
* Output only. API version used to start the operation.
*/
apiVersion?: string | null;
/**
* Output only. The time the operation was created.
*/
createTime?: string | null;
/**
* Output only. The time the operation finished running.
*/
endTime?: string | null;
/**
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
*/
requestedCancellation?: boolean | null;
/**
* Output only. Human-readable status of the operation, if any.
*/
statusMessage?: string | null;
/**
* Output only. Server-defined resource path for the target of the operation.
*/
target?: string | null;
/**
* Output only. Name of the verb executed by the operation.
*/
verb?: string | null;
}
/**
* Represents the protocol of an Agent.
*/
export interface Schema$Protocol {
/**
* Output only. The connection details for the Agent.
*/
interfaces?: Schema$Interface[];
/**
* Output only. The version of the protocol, for example, the A2A Agent Card version.
*/
protocolVersion?: string | null;
/**
* Output only. The type of the protocol.
*/
type?: string | null;
}
/**
* Represents a verified Publisher of Skills. Prepopulated publishers include `publishers/cloud.google.com` and `publishers/workspace.google.com`.
*/
export interface Schema$Publisher {
/**
* Optional. Human readable display name of the publisher.
*/
displayName?: string | null;
/**
* Optional. URI pointing to official publisher documentation.
*/
documentationUri?: string | null;
/**
* Identifier. Resource name of the publisher. Format: `projects/{project\}/locations/{location\}/publishers/{publisher\}`
*/
name?: string | null;
/**
* Output only. The curation tier of the publisher.
*/
publisherTier?: string | null;
/**
* Optional. URI pointing to the support portal or email.
*/
supportUri?: string | null;
/**
* Required. The verified prefix (e.g. "snowflake-", "google-") associated with this publisher. The system uses this prefix to enforce name-squatting rules during Skill registration. Must be globally unique across all publishers.
*/
verifiedPrefix?: string | null;
}
/**
* Message for searching Agents
*/
export interface Schema$SearchAgentsRequest {
/**
* Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
*/
pageSize?: number | null;
/**
* Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.
*/
pageToken?: string | null;
/**
* Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all accessible Agents will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | agentId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | skills | No | Yes | No | Included | | skills.id | No | Yes | No | Included | | skills.name | No | Yes | No | Included | | skills.description | No | Yes | No | Included | | skills.tags | No | Yes | No | Included | | skills.examples | No | Yes | No | Included | Examples: * `agentId="urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234"` to find the agent with the specified agent ID. * `name:important` to find agents whose name contains `important` as a word. * `displayName:works*` to find agents whose display name contains words that start with `works`. * `skills.tags:test` to find agents whose skills tags contain `test`. * `planner OR booking` to find agents whose metadata contains the words `planner` or `booking`.
*/
searchString?: string | null;
}
/**
* Message for response to searching Agents
*/
export interface Schema$SearchAgentsResponse {
/**
* A list of Agents that match the `search_string`.
*/
agents?: Schema$Agent[];
/**
* If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
*/
nextPageToken?: string | null;
}
/**
* Message for searching MCP Servers
*/
export interface Schema$SearchMcpServersRequest {
/**
* Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
*/
pageSize?: number | null;
/**
* Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call.
*/
pageToken?: string | null;
/**
* Optional. Search criteria used to select the MCP Servers to return. If no search criteria is specified then all accessible MCP Servers will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |--------------------|-----|-----|-----|----------------| | mcpServerId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | Examples: * `mcpServerId="urn:mcp:projects-123:projects:123:locations:us-central1:agentregistry:services:service-id"` to find the MCP Server with the specified MCP Server ID. * `name:important` to find MCP Servers whose name contains `important` as a word. * `displayName:works*` to find MCP Servers whose display name contains words that start with `works`. * `planner OR booking` to find MCP Servers whose metadata contains the words `planner` or `booking`. * `mcpServerId:service-id AND (displayName:planner OR displayName:booking)` to find MCP Servers whose MCP Server ID contains `service-id` and whose display name contains `planner` or `booking`.
*/
searchString?: string | null;
}
/**
* Message for response to searching MCP Servers
*/
export interface Schema$SearchMcpServersResponse {
/**
* A list of McpServers that match the `search_string`.
*/
mcpServers?: Schema$McpServer[];
/**
* If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
*/
nextPageToken?: string | null;
}
/**
* Response listing searched Skills.
*/
export interface Schema$SearchSkillsResponse {
/**
* Query page offset continuation token.
*/
nextPageToken?: string | null;
/**
* Matched Skills list.
*/
skills?: Schema$Skill[];
}
/**
* Represents a user-defined Service.
*/
export interface Schema$Service {
/**
* Optional. The spec of the Agent. When `agent_spec` is set, the type of the service is Agent.
*/
agentSpec?: Schema$AgentSpec;
/**
* Output only. Create time.
*/
createTime?: string | null;
/**
* Optional. User-defined description of an Service. Can have a maximum length of `2048` characters.
*/
description?: string | null;
/**
* Optional. User-defined display name for the Service. Can have a maximum length of `63` characters.
*/
displayName?: string | null;
/**
* Optional. The spec of the Endpoint. When `endpoint_spec` is set, the type of the service is Endpoint.
*/
endpointSpec?: Schema$EndpointSpec;
/**
* Optional. The connection details for the Service.
*/
interfaces?: Schema$Interface[];
/**
* Optional. The spec of the MCP Server. When `mcp_server_spec` is set, the type of the service is MCP Server.
*/
mcpServerSpec?: Schema$McpServerSpec;
/**
* Identifier. The resource name of the Service. Format: `projects/{project\}/locations/{location\}/services/{service\}`.
*/
name?: string | null;
/**
* Output only. The resource name of the resulting Agent, MCP Server, or Endpoint. Format: * `projects/{project\}/locations/{location\}/mcpServers/{mcp_server\}` * `projects/{project\}/locations/{location\}/agents/{agent\}` * `projects/{project\}/locations/{location\}/endpoints/{endpoint\}`
*/
registryResource?: string | null;
/**
* Output only. Update time.
*/
updateTime?: string | null;
}
/**
* Represents an Executable Agent Skill or a Composite Tool Suite (Bundle). Sibling resource with Agent and McpServer under agentregistry.googleapis.com.
*/
export interface Schema$Skill {
/**
* Output only. Create time.
*/
createTime?: string | null;
/**
* Optional. The full resource name of the revision currently served by default (floating track). Format: `projects/{project\}/locations/{location\}/skills/{skill\}/revisions/{revision\}`
*/
defaultRevision?: string | null;
/**
* Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters.
*/
description?: string | null;
/**
* Required. Human-readable display name of the skill. Maximum length is 128 characters.
*/
displayName?: string | null;
/**
* Output only. Lightweight frontmatter metadata attributes copied from the default revision.
*/
frontmatter?: Schema$Frontmatter;
/**
* Optional. Input only. Optional nested initial revision payload to support standard one-shot creation. The server processes this field on input during creation but must never return it in responses.
*/
initialRevision?: Schema$SkillRevision;
/**
* Identifier. Resource name of the Skill. Format: `projects/{project\}/locations/{location\}/skills/{skill\}` The `{skill\}` segment acts as the resource ID. If the skill is associated with a Publisher, this segment typically uses a hyphenated namespace prefix corresponding to the publisher (e.g., `google-workspace-create-docs`).
*/
name?: string | null;
/**
* Optional. The publisher resource associated with this skill. Format: `projects/{project\}/locations/{location\}/publishers/{publisher\}` The publisher dictates the allowed namespace prefixes for the skill's name and logical `skill_id` (e.g., Publisher `google` authorizes the `google-*` prefix).
*/
publisher?: string | null;
/**
* Output only. A stable, globally unique logical identifier for the skill. It is securely constructed by the backend by combining the associated `publisher`'s verified namespace and the skill's resource ID to enforce strict ownership. For example, the prefix `google-` is reserved exclusively for first-party Google publishers to prevent namespace squatting. Example: `urn:skill:google-workspace:create-docs`
*/
skillId?: string | null;
/**
* Output only. The system-managed state of the skill.
*/
state?: string | null;
/**
* Required. User-managed target state of the skill.
*/
targetState?: string | null;
/**
* Required. Structural deployment type (SIMPLE leaf vs COMPOSITE bundle).
*/
type?: string | null;
/**
* Output only. Universally unique identifier (UUID4) for the logical container.
*/
uid?: string | null;
/**
* Output only. Update time.
*/
updateTime?: string | null;
}
/**
* Represents an immutable, versioned snapshot of a Skill package.
*/
export interface Schema$SkillRevision {
/**
* Optional. Immutable. Direct write-only raw archive upload source.
*/
archiveUploadSource?: Schema$ArchiveUploadSource;
/**
* Output only. Revision creation timestamp.
*/
createTime?: string | null;
/**
* Output only. Extracted YAML frontmatter configuration snapshot.
*/
frontmatter?: Schema$Frontmatter;
/**
* Optional. Immutable. Cloud Storage object generation URI.
*/
gcsSource?: Schema$GcsSource;
/**
* Identifier. Resource name of the SkillRevision. Format: `projects/{project\}/locations/{location\}/skills/{skill\}/revisions/{revision\}`
*/
name?: string | null;
/**
* Output only. Cryptographic SHA-256 integrity and deduplication digest of the payload zip.
*/
sha256Hash?: string | null;
/**
* Output only. Size of the compiled zip payload in bytes (assists client download progress).
*/
sizeBytes?: string | null;
/**
* Output only. The system-managed lifecycle state of this revision.
*/
state?: string | null;
/**
* Output only. Universally unique identifier (UUID4) for the skill revision.
*/
uid?: string | null;
}
/**
* The source of the Binding.
*/
export interface Schema$Source {
/**
* The identifier of the source Agent. Format: * `urn:agent:{publisher\}:{namespace\}:{name\}`
*/
identifier?: string | null;
}
/**
* The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
*/
export interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number | null;
/**
* A list of messages that carry the error details. There is a common set of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}> | null;
/**
* 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.
*/
message?: string | null;
}
/**
* The target of the Binding.
*/
export interface Schema$Target {
/**
* The identifier of the target Agent, MCP Server, or Endpoint. Format: * `urn:agent:{publisher\}:{namespace\}:{name\}` * `urn:mcp:{publisher\}:{namespace\}:{name\}` * `urn:endpoint:{publisher\}:{namespace\}:{name\}`
*/
identifier?: string | null;
}
/**
* Represents a single tool provided by an MCP Server.
*/
export interface Schema$Tool {
/**
* Output only. Annotations associated with the tool.
*/
annotations?: Schema$Annotations;
/**
* Output only. Description of what the tool does.
*/
description?: string | null;
/**
* Output only. Human-readable name of the tool.
*/
name?: string | null;
}
export class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Locations {
context: APIRequestContext;
agents: Resource$Projects$Locations$Agents;
bindings: Resource$Projects$Locations$Bindings;
endpoints: Resource$Projects$Locations$Endpoints;
mcpServers: Resource$Projects$Locations$Mcpservers;
operations: Resource$Projects$Locations$Operations;
publishers: Resource$Projects$Locations$Publishers;
services: Resource$Projects$Locations$Services;
skills: Resource$Projects$Locations$Skills;
constructor(context: APIRequestContext);
/**
* Gets information about a location.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/agentregistry.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const agentregistry = google.agentregistry('v1alpha');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/agentregistry.read-write',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await agentregistry.projects.locations.get({
* // Resource name for the location.
* name: 'projects/my-project/locations/my-location',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "displayName": "my_displayName",
* // "labels": {},
* // "locationId": "my_locationId",
* // "metadata": {},
* // "name": "my_name"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
get(params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Location>>;
get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Locations$Get, options: MethodOptions | BodyResponseCallback<Schema$Location>, callback: BodyResponseCallback<Schema$Location>): void;
get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$Location>): void;
get(callback: BodyResponseCallback<Schema$Location>): void;
/**
* Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/agentregistry.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const agentregistry = google.agentregistry('v1alpha');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/agentregistry.read-write',
* 'https://www.googleapis.com/auth/cloud-platform',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await agentregistry.projects.locations.list({
* // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
* extraLocationTypes: 'placeholder-value',
* // A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
* filter: 'placeholder-value',
* // The resource that owns the locations collection, if applicable.
* name: 'projects/my-project',
* // The maximum number of results to return. If not set, the service selects a default.
* pageSize: 'placeholder-value',
* // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "locations": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
list(params?: Params$Resource$Projects$Locations$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListLocationsResponse>>;
list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsRe