REST Resource: projects.locations.apps.toolsets

Ressource : Toolset

Un ensemble d'outils représente un groupe d'outils gérés de manière dynamique et pouvant être utilisés par l'agent.

Représentation JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "timeout": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionType": enum (ExecutionType),
  "toolFakeConfig": {
    object (ToolFakeConfig)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "mcpToolset": {
    object (McpToolset)
  },
  "openApiToolset": {
    object (OpenApiToolset)
  },
  "connectorToolset": {
    object (ConnectorToolset)
  }
  // End of mutually exclusive fields.
}
Champs
name

string

Identifiant. Identifiant unique de l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

displayName

string

Facultatif. Nom à afficher de l'ensemble d'outils. Cet ID doit être unique dans la même application.

description

string

Facultatif. Description de l'ensemble d'outils.

timeout

string (Duration format)

Facultatif. Délai d'expiration pour l'exécution de l'ensemble d'outils. Si ce champ n'est pas défini, le délai avant expiration par défaut est de 30 secondes pour les ensembles d'outils SYNCHRONOUS et de 60 secondes pour les ensembles d'outils ASYNCHRONOUS.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la création de l'ensemble d'outils.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de l'ensemble d'outils.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

etag

string

ETag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.

executionType

enum (ExecutionType)

Facultatif. Type d'exécution des outils dans l'ensemble d'outils.

toolFakeConfig

object (ToolFakeConfig)

Facultatif. Configuration du comportement des outils en mode factice.

Type de l'ensemble d'outils. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
mcpToolset

object (McpToolset)

Facultatif. Ensemble d'outils contenant la liste des outils proposés par le serveur MCP.

openApiToolset

object (OpenApiToolset)

Facultatif. Ensemble d'outils contenant une liste d'outils définis par un schéma OpenAPI.

connectorToolset

object (ConnectorToolset)

Facultatif. Ensemble d'outils qui génère des outils à partir d'une connexion Integration Connectors.

Fin des champs qui s'excluent mutuellement.

McpToolset

Ensemble d'outils contenant la liste des outils proposés par le serveur MCP.

Représentation JSON
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
Champs
serverAddress

string

Obligatoire. Adresse du serveur MCP (par exemple, "https://example.com/mcp/"). Si le serveur est créé avec le SDK MCP, l'URL doit être suffixée par "/mcp/". Seuls les serveurs basés sur le transport HTTP en flux continu sont acceptés. Pour en savoir plus, consultez https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.

apiAuthentication

object (ApiAuthentication)

Facultatif. Informations d'authentification requises pour accéder aux outils et exécuter un outil sur le serveur MCP. Pour l'authentification par jeton du porteur, le jeton ne s'applique qu'à l'exécution des outils, et non à la liste des outils. Cela nécessite que les outils puissent être listés sans authentification.

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facultatif. Configuration de l'annuaire des services pour VPC-SC, utilisée pour résoudre les noms de service dans un périmètre.

tlsConfig

object (TlsConfig)

Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés auxquels le client doit faire confiance.

customHeaders

map (key: string, value: string)

Facultatif. En-têtes personnalisés à envoyer dans la requête au serveur MCP. Les valeurs doivent être au format $context.variables.<name_of_variable> et peuvent être définies dans les variables de session. Pour en savoir plus, consultez https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

toolOverrides[]

object (McpToolOverride)

Facultatif. Remplacements pour les outils individuels de cet ensemble d'outils. Cela permet de remplacer des détails spécifiques tels que les descriptions ou les noms, ou d'épingler les états des outils afin qu'ils ne soient pas entièrement dynamiques.

McpToolOverride

Remplacements associés à un outil donné dans un Toolset. Cela permet d'épingler ou de remplacer les définitions d'outils à partir du serveur dynamique externe.

Représentation JSON
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
Champs
tool

string

Obligatoire. Nom d'origine de l'outil tel qu'il est émis par le serveur MCP.

nameOverride

string

Facultatif. Si ce nom est présent, l'outil l'utilise dans l'agent au lieu du nom d'origine. Il est principalement utilisé comme alias si le serveur MCP propose des outils mal nommés.

descriptionOverride

string

Facultatif. Si elle est présente, cet outil utilise cette description au lieu de la description d'origine du serveur.

snapshot

object (McpToolDefinition)

Uniquement en sortie. Si cet outil est présent, il est "épinglé" et utilise les valeurs du snapshot comme valeurs de remplacement si le serveur devient temporairement indisponible ou si aucune valeur de remplacement n'est présente.

McpToolDefinition

Conteneur pour les éléments de définition de base d'un outil qui sont des instantanés. Les schémas de l'instantané sont utilisés tels quels et ne peuvent pas être remplacés.

Représentation JSON
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
Champs
description

string

Uniquement en sortie. Description de l'outil MCP. Cette valeur peut être remplacée par descriptionOverride dans McpToolOverride.

inputSchema

object (Schema)

Uniquement en sortie. Schéma des arguments d'entrée de l'outil MCP.

outputSchema

object (Schema)

Uniquement en sortie. Schéma des arguments de sortie de l'outil MCP.

OpenApiToolset

Ensemble d'outils contenant une liste d'outils définis par un schéma OpenAPI.

Représentation JSON
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
Champs
openApiSchema

string

Obligatoire. Schéma OpenAPI de l'ensemble d'outils.

apiAuthentication

object (ApiAuthentication)

Facultatif. Informations d'authentification requises par l'API.

tlsConfig

object (TlsConfig)

Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés

serviceDirectoryConfig

object (ServiceDirectoryConfig)

Facultatif. Configuration de l'annuaire des services.

ignoreUnknownFields

boolean

Facultatif. Si la valeur est "true", l'agent ignore les champs inconnus dans la réponse de l'API pour toutes les opérations définies dans le schéma OpenAPI.

url

string

Facultatif. URL du serveur du schéma Open API. Ce champ n'est défini dans les ensembles d'outils que dans les dépendances de l'environnement pendant le processus d'exportation si le schéma contient une URL de serveur. Lors du processus d'importation, si cette URL est présente dans les dépendances de l'environnement et que le schéma comporte l'espace réservé $env_var, elle remplacera l'espace réservé dans le schéma.

ConnectorToolset

Ensemble d'outils qui génère des outils à partir d'une connexion Integration Connectors.

Représentation JSON
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
Champs
connection

string

Obligatoire. Nom complet de la ressource de la connexion Integration Connectors référencée. Format : projects/{project}/locations/{location}/connections/{connection}

authConfig

object (EndUserAuthConfig)

Facultatif. Configure la façon dont l'authentification est gérée dans Integration Connectors. Par défaut, une authentification d'administrateur est transmise dans les requêtes API Integration Connectors. Vous pouvez le remplacer par une autre configuration d'authentification de l'utilisateur final. Remarque : La substitution de l'authentification doit être activée pour la connexion afin de pouvoir spécifier une configuration EUC ici. Sinon, la création de l'ensemble d'outils échouera. Consultez https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.

connectorActions[]

object (Action)

Obligatoire. Liste des actions/opérations d'entité du connecteur pour lesquelles générer des outils.

Méthodes

create

Crée un ensemble d'outils dans l'application spécifiée.

delete

Supprime l'ensemble d'outils spécifié.

get

Obtient les détails de l'ensemble d'outils spécifié.

list

Liste les ensembles d'outils dans l'application spécifiée.

patch

Met à jour l'ensemble d'outils spécifié.

retrieveTools

Récupérez la liste des outils inclus dans l'ensemble d'outils spécifié.