Skip to content

synchronize_gateway_targets

Operation

synchronize_gateway_targets

synchronize_gateway_targets(request: SynchronizeGatewayTargetsInput | SynchronizeGatewayTargetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SynchronizeGatewayTargetsInputDict]) -> SynchronizeGatewayTargetsOutput

Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.

You cannot synchronize a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before synchronizing.

You cannot synchronize a target that has a static tool schema (mcpToolSchema) configured. Remove the static schema through an UpdateGatewayTarget call to enable dynamic tool synchronization.

Parameters:

Name Type Description Default
request SynchronizeGatewayTargetsInput | SynchronizeGatewayTargetsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[SynchronizeGatewayTargetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SynchronizeGatewayTargetsOutput

An instance of SynchronizeGatewayTargetsOutput.

synchronize_gateway_targets async

synchronize_gateway_targets(request: SynchronizeGatewayTargetsInput | SynchronizeGatewayTargetsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SynchronizeGatewayTargetsInputDict]) -> SynchronizeGatewayTargetsOutput

Synchronizes the gateway targets by fetching the latest tool definitions from the target endpoints.

You cannot synchronize a target that is in a pending authorization state (CREATE_PENDING_AUTH, UPDATE_PENDING_AUTH, or SYNCHRONIZE_PENDING_AUTH). Wait for the authorization to complete or fail before synchronizing.

You cannot synchronize a target that has a static tool schema (mcpToolSchema) configured. Remove the static schema through an UpdateGatewayTarget call to enable dynamic tool synchronization.

Parameters:

Name Type Description Default
request SynchronizeGatewayTargetsInput | SynchronizeGatewayTargetsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[SynchronizeGatewayTargetsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SynchronizeGatewayTargetsOutput

An instance of SynchronizeGatewayTargetsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

SynchronizeGatewayTargetsInputDict

Bases: TypedDict

Dictionary form of SynchronizeGatewayTargetsInput.

Attributes

gateway_identifier instance-attribute
gateway_identifier: Required[str]

The gateway Identifier.

target_id_list instance-attribute
target_id_list: Required[Sequence[str]]

The target ID list.

SynchronizeGatewayTargetsInput dataclass

Bases: _SerdeShape

Dataclass for SynchronizeGatewayTargetsInput structure.

Attributes

gateway_identifier class-attribute instance-attribute
gateway_identifier: str | None = ...

The gateway Identifier.

target_id_list class-attribute instance-attribute
target_id_list: list[str] | None = ...

The target ID list.

Output

SynchronizeGatewayTargetsOutput dataclass

Bases: _SerdeShape

Dataclass for SynchronizeGatewayTargetsOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

targets class-attribute instance-attribute
targets: list[GatewayTarget] | None = ...

The gateway targets for synchronization.