Gcp/ces
@swamp/gcp/cesv2026.06.12.1
01README
Google Cloud ces infrastructure models
02Release Notes
- Updated: apps_agents, apps_tools, apps_toolsets, apps_versions
03Models
@swamp/gcp/ces/appsv2026.06.08.1apps.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| audioProcessingConfig? | object | Configuration for how the input and output audio should be processed and delivered. |
| clientCertificateSettings? | object | Settings for custom client certificates. |
| dataStoreSettings? | object | Data store related settings for the app. |
| defaultChannelProfile? | object | A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. |
| description? | string | Optional. Human-readable description of the app. |
| displayName? | string | Required. Display name of the app. |
| errorHandlingSettings? | object | Settings to describe how errors should be handled in the app. |
| evaluationMetricsThresholds? | object | Threshold settings for metrics in an Evaluation. |
| globalInstruction? | string | Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents. |
| guardrails? | array | Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` |
| languageSettings? | object | Language settings of the app. |
| locked? | boolean | Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. |
| loggingSettings? | object | Settings to describe the logging behaviors for the app. |
| metadata? | record | Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. |
| modelSettings? | object | Model settings contains various configurations for the LLM model. |
| name? | string | Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}` |
| pinned? | boolean | Optional. Whether the app is pinned in the app list. |
| rootAgent? | string | Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| timeZoneSettings? | object | TimeZone settings of the app. |
| toolExecutionMode? | enum | Optional. The tool execution mode for the app. If not provided, will default to PARALLEL. |
| variableDeclarations? | array | Optional. The declarations of the variables. |
| vpcScSettings? | object | VPC-SC settings for the app. |
| appId? | string | Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a apps
fn get(identifier: string)
Get a apps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apps |
fn update()
Update apps attributes
fn delete(identifier: string)
Delete the apps
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the apps |
fn sync()
Sync apps state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List apps resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the apps. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn execute_tool(args?: any, context?: any, mockConfig?: any, tool?: any, toolsetTool?: any, variables?: any)
execute tool
| Argument | Type | Description |
|---|---|---|
| args? | any | |
| context? | any | |
| mockConfig? | any | |
| tool? | any | |
| toolsetTool? | any | |
| variables? | any |
fn export_app(appVersion?: any, exportFormat?: any, gcsUri?: any)
export app
| Argument | Type | Description |
|---|---|---|
| appVersion? | any | |
| exportFormat? | any | |
| gcsUri? | any |
fn import_app(appContent?: any, appId?: any, displayName?: any, gcsUri?: any, ignoreAppLock?: any, importOptions?: any)
import app
| Argument | Type | Description |
|---|---|---|
| appContent? | any | |
| appId? | any | |
| displayName? | any | |
| gcsUri? | any | |
| ignoreAppLock? | any | |
| importOptions? | any |
fn retrieve_tool_schema(tool?: any, toolsetTool?: any)
retrieve tool schema
| Argument | Type | Description |
|---|---|---|
| tool? | any | |
| toolsetTool? | any |
Resources
state(infinite)— An app serves as a top-level container for a group of agents, including the r...
@swamp/gcp/ces/apps-agentsv2026.06.12.1apps_agents.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| afterAgentCallbacks? | array | Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| afterModelCallbacks? | array | Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| afterToolCallbacks? | array | Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| beforeAgentCallbacks? | array | Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| beforeModelCallbacks? | array | Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| beforeToolCallbacks? | array | Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| childAgents? | array | Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| description? | string | Optional. Human-readable description of the agent. |
| displayName? | string | Required. Display name of the agent. |
| guardrails? | array | Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` |
| instruction? | string | Optional. Instructions for the LLM model to guide the agent's behavior. |
| llmAgent? | object | Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model. |
| modelSettings? | object | Model settings contains various configurations for the LLM model. |
| name? | string | Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| remoteDialogflowAgent? | object | The agent which will transfer execution to a remote [Dialogflow CX](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent. |
| tools? | array | Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` |
| toolsets? | array | Optional. List of toolsets for the agent. |
| transferRules? | array | Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used. |
| agentId? | string | Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a agents
fn get(identifier: string)
Get a agents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the agents |
fn update()
Update agents attributes
fn delete(identifier: string)
Delete the agents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the agents |
fn sync()
Sync agents state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List agents resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the agents. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An agent acts as the fundamental building block that provides instructions to...
@swamp/gcp/ces/apps-changelogsv2026.06.08.1apps_changelogs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a changelogs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the changelogs |
fn sync()
Sync changelogs state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List changelogs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the changelogs. See https://google.aip.dev/160 for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: * `action:update` (case-insensitive partial match) * `action="Create"` (case-sensitive exact match) * `resource_type:agent` * `r |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Changelogs represent a change made to the app or to an resource within the app.
@swamp/gcp/ces/apps-conversationsv2026.06.08.1apps_conversations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn delete(identifier: string)
Delete the conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn sync()
Sync conversations state from GCP
fn list(filter?: string, pageSize?: number, source?: string, sources?: string, maxPages?: number)
List conversations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the conversations. See https://google.aip.dev/160 for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| source? | string | Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field. |
| sources? | string | Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn batch_delete(conversations?: any)
batch delete
| Argument | Type | Description |
|---|---|---|
| conversations? | any |
Resources
state(infinite)— A conversation represents an interaction between an end user and the CES app.
@swamp/gcp/ces/apps-deploymentsv2026.06.08.1apps_deployments.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| appVersion? | string | Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. |
| channelProfile? | object | A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony. |
| displayName? | string | Required. Display name of the deployment. |
| experimentConfig? | object | Experiment for the deployment. |
| name? | string | Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |
| deploymentId? | string | Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a deployments
fn get(identifier: string)
Get a deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn update()
Update deployments attributes
fn delete(identifier: string)
Delete the deployments
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the deployments |
fn sync()
Sync deployments state from GCP
fn list(orderBy?: string, pageSize?: number, maxPages?: number)
List deployments resources
| Argument | Type | Description |
|---|---|---|
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A deployment represents an immutable, queryable version of the app. It is use...
@swamp/gcp/ces/apps-examplesv2026.06.08.1apps_examples.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| description? | string | Optional. Human-readable description of the example. |
| displayName? | string | Required. Display name of the example. |
| entryAgent? | string | Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| messages? | array | Optional. The collection of messages that make up the conversation. |
| name? | string | Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}` |
| exampleId? | string | Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a examples
fn get(identifier: string)
Get a examples
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the examples |
fn update()
Update examples attributes
fn delete(identifier: string)
Delete the examples
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the examples |
fn sync()
Sync examples state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List examples resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the examples. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— An example represents a sample conversation between the user and the agent(s).
@swamp/gcp/ces/apps-guardrailsv2026.06.08.1apps_guardrails.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| action? | object | Action that is taken when a certain precondition is met. |
| codeCallback? | object | Guardrail that blocks the conversation based on the code callbacks provided. |
| contentFilter? | object | Guardrail that bans certain content from being used in the conversation. |
| description? | string | Optional. Description of the guardrail. |
| displayName? | string | Required. Display name of the guardrail. |
| enabled? | boolean | Optional. Whether the guardrail is enabled. |
| llmPolicy? | object | Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. |
| llmPromptSecurity? | object | Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification. |
| modelSafety? | object | Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe. |
| name? | string | Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` |
| guardrailId? | string | Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a guardrails
fn get(identifier: string)
Get a guardrails
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the guardrails |
fn update()
Update guardrails attributes
fn delete(identifier: string)
Delete the guardrails
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the guardrails |
fn sync()
Sync guardrails state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List guardrails resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the guardrails. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Guardrail contains a list of checks and balances to keep the agents safe and ...
@swamp/gcp/ces/apps-toolsv2026.06.12.1apps_tools.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| agentTool? | object | Represents a tool that allows the agent to call another agent. |
| clientFunction? | object | Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. |
| connectorTool? | object | A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview. |
| dataStoreTool? | object | Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction. |
| executionType? | enum | Optional. The execution type of the tool. |
| fileSearchTool? | object | The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results. |
| googleSearchTool? | object | Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search. |
| mcpTool? | object | An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details. |
| name? | string | Identifier. The resource name of the tool. Format: * `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. * `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. |
| openApiTool? | object | A remote API tool defined by an OpenAPI schema. |
| pythonFunction? | object | A Python function tool. |
| remoteAgentTool? | object | Represents a tool that allows the agent to call another remote agent. |
| systemTool? | object | Pre-defined system tool. |
| timeout? | string | Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools. |
| toolFakeConfig? | object | Configuration for tool behavior in fake mode. |
| widgetTool? | object | Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent. |
| toolId? | string | Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a tools
fn get(identifier: string)
Get a tools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tools |
fn update()
Update tools attributes
fn delete(identifier: string)
Delete the tools
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tools |
fn sync()
Sync tools state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List tools resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A tool represents an action that the CES agent can take to achieve certain go...
@swamp/gcp/ces/apps-toolsetsv2026.06.12.1apps_toolsets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| connectorToolset? | object | A toolset that generates tools from an Integration Connectors Connection. |
| description? | string | Optional. The description of the toolset. |
| displayName? | string | Optional. The display name of the toolset. Must be unique within the same app. |
| executionType? | enum | Optional. The execution type of the tools in the toolset. |
| mcpToolset? | object | A toolset that contains a list of tools that are offered by the MCP server. |
| name? | string | Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` |
| openApiToolset? | object | A toolset that contains a list of tools that are defined by an OpenAPI schema. |
| toolFakeConfig? | object | Configuration for tool behavior in fake mode. |
| toolsetId? | string | Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a toolsets
fn get(identifier: string)
Get a toolsets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the toolsets |
fn update()
Update toolsets attributes
fn delete(identifier: string)
Delete the toolsets
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the toolsets |
fn sync()
Sync toolsets state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List toolsets resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the toolsets. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn retrieve_tools(bypassPersistenceConfig?: any, toolIds?: any)
retrieve tools
| Argument | Type | Description |
|---|---|---|
| bypassPersistenceConfig? | any | |
| toolIds? | any |
Resources
state(infinite)— A toolset represents a group of dynamically managed tools that can be used by...
@swamp/gcp/ces/apps-versionsv2026.06.12.1apps_versions.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| description? | string | Optional. The description of the app version. |
| displayName? | string | Optional. The display name of the app version. |
| name? | string | Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` |
| snapshot? | object | A snapshot of the app. |
| appVersionId? | string | Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a versions
fn get(identifier: string)
Get a versions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the versions |
fn delete(identifier: string)
Delete the versions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the versions |
fn sync()
Sync versions state from GCP
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List versions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter to be applied when listing the app versions. See https://google.aip.dev/160 for more details. |
| orderBy? | string | Optional. Field to sort by. Only "name" and "create_time" is supported. See https://google.aip.dev/132#ordering for more details. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn restore()
restore
Resources
state(infinite)— In Customer Engagement Suite (CES), an app version is a snapshot of the app a...
@swamp/gcp/ces/locationsv2026.06.08.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync()
Sync locations state from GCP
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | 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). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
04Previous Versions
2026.06.08.2Jun 8, 2026
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.06.07.1Jun 7, 2026
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.06.06.1Jun 6, 2026
- Updated: apps_agents, apps_tools, apps_toolsets, apps_versions
2026.06.05.2Jun 5, 2026
- Updated: apps_agents, apps_tools, apps_toolsets, apps_versions
2026.06.05.1Jun 5, 2026
- Updated: apps_agents, apps_tools, apps_toolsets, apps_versions
2026.06.04.1Jun 4, 2026
- Updated: apps_agents, apps_tools, apps_toolsets, apps_versions
2026.05.27.1May 27, 2026
- Updated: apps, apps_conversations, apps_tools
2026.05.26.1May 26, 2026
- Updated: locations, apps, apps_agents, apps_deployments, apps_tools, apps_toolsets, apps_versions
2026.05.25.2May 25, 2026
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
Modified 11 models
2026.05.25.1May 25, 2026
- Updated: apps_agents, apps_tools, apps_toolsets, apps_versions
2026.05.24.1May 24, 2026
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.05.21.2May 21, 2026
- Updated: locations, apps, apps_agents, apps_changelogs, apps_conversations, apps_deployments, apps_examples, apps_guardrails, apps_tools, apps_toolsets, apps_versions
2026.05.21.1May 21, 2026
2026.05.20.1May 20, 2026
- Updated: apps, apps_agents, apps_deployments, apps_tools, apps_versions
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.2May 18, 2026
2026.05.09.1May 9, 2026
- Updated: apps, apps_agents, apps_tools, apps_versions
2026.04.23.2Apr 23, 2026
- Updated: apps, apps_deployments, apps_tools, apps_versions
05Stats
A
100 / 100
Downloads
0
Archive size
314.9 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels