MCPToolboxTool Class

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Returns

Remove all items from the dictionary.

clear() -> None

copy() -> Model

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

items() -> ItemsView[str, Any]

Returns

keys() -> KeysView[str]

Returns

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values() -> ValuesView[Any]

Returns

allowed_callers: list[typing.Union[str, ForwardRef('_models.CallableToolAllowedCaller')]] | None

Is either a [str] type or a MCPToolFilter type.

allowed_tools: list[str] | _models.MCPToolFilter | None

An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.

authorization: str | None

Identifier for service connectors, like those available in ChatGPT. One of server_url, connector_id, or tunnel_id must be provided. Learn more about service connectors here. Currently supported connector_id values are:

• Dropbox: connector_dropbox

• Gmail: connector_gmail

• Google Calendar: connector_googlecalendar

• Google Drive: connector_googledrive

• Microsoft Teams: connector_microsoftteams

• Outlook Calendar: connector_outlookcalendar

• Outlook Email: connector_outlookemail

• SharePoint: connector_sharepoint. Is one of the following types: Literal["connector_dropbox"], Literal["connector_gmail"], Literal["connector_googlecalendar"], Literal["connector_googledrive"], Literal["connector_microsoftteams"], Literal["connector_outlookcalendar"], Literal["connector_outlookemail"], Literal["connector_sharepoint"]

connector_id: Literal['connector_dropbox', 'connector_gmail', 'connector_googlecalendar', 'connector_googledrive', 'connector_microsoftteams', 'connector_outlookcalendar', 'connector_outlookemail', 'connector_sharepoint'] | None

Whether this MCP tool is deferred and discovered via tool search.

defer_loading: bool | None

Optional user-defined description for this tool or configuration.

description: str | None

headers: dict[str, str] | None

Optional user-defined name for this tool or configuration.

name: str | None

The connection ID in the project for the MCP server. The connection stores authentication and other connection details needed to connect to the MCP server.

project_connection_id: str | None

MCPToolRequireApproval, Literal["always"], Literal["never"]

require_approval: _models.MCPToolRequireApproval | Literal['always'] | Literal['never'] | None

Optional description of the MCP server, used to provide more context.

server_description: str | None

A label for this MCP server, used to identify it in tool calls. Required.

server_label: str

The URL for the MCP server. One of server_url, connector_id, or tunnel_id must be provided.

server_url: str | None

Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

tool_configs: dict[str, '_models.ToolConfig'] | None

The Secure MCP Tunnel ID to use instead of a direct server URL. One of server_url, connector_id, or tunnel_id must be provided.

tunnel_id: str | None

Required. MCP.

type: MCP: 'mcp'>]