REST Resource: projects.locations.apps.toolsets

リソース: Toolset

ツールセットは、エージェントが使用できる動的に管理されるツールのグループを表します。

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.
}
フィールド
name

string

ID。ツールセットの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
displayName

string

省略可。ツールセットの表示名。同じアプリ内で一意である必要があります。
description

string

省略可。ツールセットの説明。
timeout

string (Duration format)

省略可。ツールセットの実行のタイムアウト。設定しない場合、デフォルトのタイムアウトは SYNCHRONOUS ツールセットで 30 秒、ASYNCHRONOUS ツールセットで 60 秒です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
createTime

string (Timestamp format)

出力専用。ツールセットが作成されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。ツールセットが最後に更新されたときのタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
etag

string

read-modify-write オペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
executionType

enum (ExecutionType)

省略可。ツールセット内のツールの実行タイプ。
toolFakeConfig

object (ToolFakeConfig)

省略可。フェイクモードでのツールの動作の構成。
ツールセットのタイプ。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
mcpToolset

object (McpToolset)

省略可。MCP サーバーが提供するツールのリストを含むツールセット。
openApiToolset

object (OpenApiToolset)

省略可。OpenAPI スキーマで定義されたツールのリストを含むツールセット。
connectorToolset

object (ConnectorToolset)

省略可。Integration Connectors 接続からツールを生成するツールセット。
相互に排他的なフィールドの終わり。

McpToolset

MCP サーバーが提供するツールのリストを含むツールセット。

JSON 表現 
{
  "serverAddress": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "customHeaders": {
    string: string,
    ...
  },
  "toolOverrides": [
    {
      object (McpToolOverride)
    }
  ]
}
フィールド
serverAddress

string

必須。MCP サーバーのアドレス（例: https://example.com/mcp/）。サーバーが MCP SDK で構築されている場合、URL の末尾に「/mcp/」を付加する必要があります。ストリーミング可能な HTTP 転送ベースのサーバーのみがサポートされています。詳細については、https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http をご覧ください。
apiAuthentication

object (ApiAuthentication)

省略可。ツールにアクセスして MCP サーバーに対してツールを実行するために必要な認証情報。ベアラー トークン認証の場合、トークンはツールの実行にのみ適用され、ツールのリストには適用されません。そのため、ツールを認証なしで一覧表示できる必要があります。
serviceDirectoryConfig

object (ServiceDirectoryConfig)

省略可。VPC-SC の Service Directory 構成。境界内のサービス名の解決に使用されます。
tlsConfig

object (TlsConfig)

省略可。TLS 構成。クライアントが信頼すべきカスタム サーバー証明書が含まれます。
customHeaders

map (key: string, value: string)

省略可。MCP サーバーへのリクエストで送信するカスタム ヘッダー。値は $context.variables.<name_of_variable> 形式にする必要があり、セッション変数で設定できます。詳しくは、https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection をご覧ください。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
toolOverrides[]

object (McpToolOverride)

省略可。このツールセット内の個々のツールのオーバーライド。これにより、説明や名前などの特定の詳細をオーバーライドしたり、ツールを完全に動的にしないように状態を固定したりできます。

McpToolOverride

ツールセット内の特定のツールに関連付けられたオーバーライド。これにより、外部動的サーバーからのツール定義の「固定」または「オーバーライド」が可能になります。

JSON 表現 
{
  "tool": string,
  "nameOverride": string,
  "descriptionOverride": string,
  "snapshot": {
    object (McpToolDefinition)
  }
}
フィールド
tool

string

必須。MCP サーバーによって出力されるツールの元の名前。
nameOverride

string

省略可。この名前が存在する場合、このツールは元の名前の代わりにこの名前をエージェントで使用します。これは、MCP サーバーが名前の付け方が悪いツールを提供している場合に、主にエイリアスとして使用されます。
descriptionOverride

string

省略可。この説明が存在する場合、このツールはサーバーの元の説明ではなく、この説明を使用します。
snapshot

object (McpToolDefinition)

出力専用。このツールが存在する場合、ツールは「固定」され、サーバーが一時的に利用できなくなった場合やオーバーライドが存在しない場合は、スナップショット値がフォールバックとして使用されます。

McpToolDefinition

スナップショットされるツールのコア定義要素のコンテナ。スナップショットのスキーマはそのまま使用され、オーバーライドできません。

JSON 表現 
{
  "description": string,
  "inputSchema": {
    object (Schema)
  },
  "outputSchema": {
    object (Schema)
  }
}
フィールド
description

string

出力専用。MCP ツールの説明。これは、McpToolOverride の descriptionOverride でオーバーライドできます。
inputSchema

object (Schema)

出力専用。MCP ツールの入力引数のスキーマ。
outputSchema

object (Schema)

出力専用。MCP ツールの出力引数のスキーマ。

OpenApiToolset

OpenAPI スキーマで定義されたツールのリストを含むツールセット。

JSON 表現 
{
  "openApiSchema": string,
  "apiAuthentication": {
    object (ApiAuthentication)
  },
  "tlsConfig": {
    object (TlsConfig)
  },
  "serviceDirectoryConfig": {
    object (ServiceDirectoryConfig)
  },
  "ignoreUnknownFields": boolean,
  "url": string
}
フィールド
openApiSchema

string

必須。ツールセットの OpenAPI スキーマ。
apiAuthentication

object (ApiAuthentication)

省略可。API で必要な認証情報。
tlsConfig

object (TlsConfig)

省略可。TLS 構成。カスタム サーバー証明書が含まれます
serviceDirectoryConfig

object (ServiceDirectoryConfig)

省略可。Service Directory の構成。
ignoreUnknownFields

boolean

省略可。true の場合、エージェントは OpenAPI スキーマで定義されたすべてのオペレーションについて、API レスポンス内の不明なフィールドを無視します。
url

string

省略可。Open API スキーマのサーバー URL。このフィールドは、エクスポート プロセス中に環境の依存関係のツールセットで、スキーマにサーバー URL が含まれている場合にのみ設定されます。インポート プロセス中に、この URL が環境の依存関係に存在し、スキーマに $env_var プレースホルダがある場合、スキーマ内のプレースホルダが置き換えられます。

ConnectorToolset

Integration Connectors 接続からツールを生成するツールセット。

JSON 表現 
{
  "connection": string,
  "authConfig": {
    object (EndUserAuthConfig)
  },
  "connectorActions": [
    {
      object (Action)
    }
  ]
}
フィールド
connection

string

必須。参照される Integration Connectors Connection の完全なリソース名。形式: projects/{project}/locations/{location}/connections/{connection}
authConfig

object (EndUserAuthConfig)

省略可。Integration Connectors で認証を処理する方法を構成します。デフォルトでは、管理者の認証は Integration Connectors API リクエストで渡されます。別のエンドユーザー認証構成でオーバーライドできます。注: ここで EUC 構成を指定するには、接続で認証オーバーライドが有効になっている必要があります。有効になっていない場合、ツールセットの作成は失敗します。参照: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connectorActions[]

object (Action)

必須。ツールの生成対象となるコネクタ アクション/エンティティ オペレーションのリスト。

メソッド

create

 指定されたアプリに新しいツールセットを作成します。

delete

 指定されたツールセットを削除します。

get

 指定されたツールセットの詳細を取得します。

list

 指定されたアプリのツールセットを一覧表示します。

patch

 指定されたツールセットを更新します。

retrieveTools

 指定されたツールセットに含まれるツールのリストを取得します。