DatabaseToolsMcpToolsetCustomSqlToolSummary¶

class oci.database_tools.models.DatabaseToolsMcpToolsetCustomSqlToolSummary(**kwargs)¶

Bases: oci.database_tools.models.database_tools_mcp_toolset_summary.DatabaseToolsMcpToolsetSummary

Summary of the Database Tools MCP Toolset.

Attributes

`DEFAULT_EXECUTION_TYPE_ASYNCHRONOUS`	A constant which can be used with the default_execution_type property of a DatabaseToolsMcpToolsetCustomSqlToolSummary.
`DEFAULT_EXECUTION_TYPE_SYNCHRONOUS`	A constant which can be used with the default_execution_type property of a DatabaseToolsMcpToolsetCustomSqlToolSummary.
`LIFECYCLE_STATE_ACTIVE`	str(object=’’) -> str
`LIFECYCLE_STATE_CREATING`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETED`	str(object=’’) -> str
`LIFECYCLE_STATE_DELETING`	str(object=’’) -> str
`LIFECYCLE_STATE_FAILED`	str(object=’’) -> str
`LIFECYCLE_STATE_UPDATING`	str(object=’’) -> str
`TYPE_BUILT_IN_SQL_TOOLS`	str(object=’’) -> str
`TYPE_CUSTOMIZABLE_REPORTING_TOOLS`	str(object=’’) -> str
`TYPE_CUSTOM_SQL_TOOL`	str(object=’’) -> str
`TYPE_GENAI_SQL_ASSISTANT`	str(object=’’) -> str
`allowed_roles`	[Required] Gets the allowed_roles of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseToolsMcpToolsetSummary.
`database_tools_mcp_server_id`	[Required] Gets the database_tools_mcp_server_id of this DatabaseToolsMcpToolsetSummary.
`default_execution_type`	Gets the default_execution_type of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
`defined_tags`	Gets the defined_tags of this DatabaseToolsMcpToolsetSummary.
`display_name`	[Required] Gets the display_name of this DatabaseToolsMcpToolsetSummary.
`freeform_tags`	Gets the freeform_tags of this DatabaseToolsMcpToolsetSummary.
`id`	[Required] Gets the id of this DatabaseToolsMcpToolsetSummary.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseToolsMcpToolsetSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseToolsMcpToolsetSummary.
`locks`	Gets the locks of this DatabaseToolsMcpToolsetSummary.
`system_tags`	Gets the system_tags of this DatabaseToolsMcpToolsetSummary.
`time_created`	[Required] Gets the time_created of this DatabaseToolsMcpToolsetSummary.
`time_updated`	[Required] Gets the time_updated of this DatabaseToolsMcpToolsetSummary.
`tool_description`	Gets the tool_description of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
`tool_name`	[Required] Gets the tool_name of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
`type`	[Required] Gets the type of this DatabaseToolsMcpToolsetSummary.
`version`	[Required] Gets the version of this DatabaseToolsMcpToolsetSummary.

Methods

`__init__`(**kwargs)	Initializes a new DatabaseToolsMcpToolsetCustomSqlToolSummary object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

DEFAULT_EXECUTION_TYPE_ASYNCHRONOUS = 'ASYNCHRONOUS'¶: A constant which can be used with the default_execution_type property of a DatabaseToolsMcpToolsetCustomSqlToolSummary. This constant has a value of “ASYNCHRONOUS”

DEFAULT_EXECUTION_TYPE_SYNCHRONOUS = 'SYNCHRONOUS'¶: A constant which can be used with the default_execution_type property of a DatabaseToolsMcpToolsetCustomSqlToolSummary. This constant has a value of “SYNCHRONOUS”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶

LIFECYCLE_STATE_CREATING = 'CREATING'¶

LIFECYCLE_STATE_DELETED = 'DELETED'¶

LIFECYCLE_STATE_DELETING = 'DELETING'¶

LIFECYCLE_STATE_FAILED = 'FAILED'¶

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶

TYPE_BUILT_IN_SQL_TOOLS = 'BUILT_IN_SQL_TOOLS'¶

TYPE_CUSTOMIZABLE_REPORTING_TOOLS = 'CUSTOMIZABLE_REPORTING_TOOLS'¶

TYPE_CUSTOM_SQL_TOOL = 'CUSTOM_SQL_TOOL'¶

TYPE_GENAI_SQL_ASSISTANT = 'GENAI_SQL_ASSISTANT'¶

__init__(**kwargs)¶

Initializes a new DatabaseToolsMcpToolsetCustomSqlToolSummary object with values from keyword arguments. The default value of the type attribute of this class is CUSTOM_SQL_TOOL and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
version (int) – The value to assign to the version property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
type (str) – The value to assign to the type property of this DatabaseToolsMcpToolsetCustomSqlToolSummary. Allowed values for this property are: “CUSTOM_SQL_TOOL”, “BUILT_IN_SQL_TOOLS”, “CUSTOMIZABLE_REPORTING_TOOLS”, “GENAI_SQL_ASSISTANT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
database_tools_mcp_server_id (str) – The value to assign to the database_tools_mcp_server_id property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsMcpToolsetCustomSqlToolSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
tool_name (str) – The value to assign to the tool_name property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
tool_description (str) – The value to assign to the tool_description property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
allowed_roles (list[str]) – The value to assign to the allowed_roles property of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
default_execution_type (str) – The value to assign to the default_execution_type property of this DatabaseToolsMcpToolsetCustomSqlToolSummary. Allowed values for this property are: “SYNCHRONOUS”, “ASYNCHRONOUS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

allowed_roles¶

[Required] Gets the allowed_roles of this DatabaseToolsMcpToolsetCustomSqlToolSummary. The roles granted access to this MCP tool

Returns:	The allowed_roles of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
Return type:	list[str]

compartment_id¶

[Required] Gets the compartment_id of this DatabaseToolsMcpToolsetSummary. The OCID of the compartment containing the Database Tools MCP server.

Returns:	The compartment_id of this DatabaseToolsMcpToolsetSummary.
Return type:	str

database_tools_mcp_server_id¶

[Required] Gets the database_tools_mcp_server_id of this DatabaseToolsMcpToolsetSummary. The OCID of the related Database Tools McpServer.

Returns:	The database_tools_mcp_server_id of this DatabaseToolsMcpToolsetSummary.
Return type:	str

default_execution_type¶

Gets the default_execution_type of this DatabaseToolsMcpToolsetCustomSqlToolSummary. The default execution type for the toolset. The default value is SYNCHRONOUS.

To use ASYNCHRONOUS execution, the MCP Server must have the storage property configured.

Allowed values for this property are: “SYNCHRONOUS”, “ASYNCHRONOUS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The default_execution_type of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this DatabaseToolsMcpToolsetSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this DatabaseToolsMcpToolsetSummary.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this DatabaseToolsMcpToolsetSummary. A user-friendly name. Does not have to be unique and can be updated. Avoid entering confidential information.

Returns:	The display_name of this DatabaseToolsMcpToolsetSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this DatabaseToolsMcpToolsetSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this DatabaseToolsMcpToolsetSummary.
Return type:	dict(str, str)

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id¶

[Required] Gets the id of this DatabaseToolsMcpToolsetSummary. The OCID of the Database Tools MCP Toolset.

Returns:	The id of this DatabaseToolsMcpToolsetSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this DatabaseToolsMcpToolsetSummary. A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

Returns:	The lifecycle_details of this DatabaseToolsMcpToolsetSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseToolsMcpToolsetSummary. The current state of the Database Tools MCP Toolset.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this DatabaseToolsMcpToolsetSummary.
Return type:	str

locks¶

Gets the locks of this DatabaseToolsMcpToolsetSummary. Locks associated with this resource.

Returns:	The locks of this DatabaseToolsMcpToolsetSummary.
Return type:	list[oci.database_tools.models.ResourceLock]

system_tags¶

Gets the system_tags of this DatabaseToolsMcpToolsetSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this DatabaseToolsMcpToolsetSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this DatabaseToolsMcpToolsetSummary. The time the Database Tools MCP server was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this DatabaseToolsMcpToolsetSummary.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this DatabaseToolsMcpToolsetSummary. The time the Database Tools MCP server was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this DatabaseToolsMcpToolsetSummary.
Return type:	datetime

tool_description¶

Gets the tool_description of this DatabaseToolsMcpToolsetCustomSqlToolSummary. Instructions describing how to use the MCP toolset and its features. This can be used to improve the LLM’s understanding of the tool.

Returns:	The tool_description of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
Return type:	str

tool_name¶

[Required] Gets the tool_name of this DatabaseToolsMcpToolsetCustomSqlToolSummary. Name of the tool returned by the MCP Server

Returns:	The tool_name of this DatabaseToolsMcpToolsetCustomSqlToolSummary.
Return type:	str

type¶

[Required] Gets the type of this DatabaseToolsMcpToolsetSummary. The Database Tools MCP Toolset type.

Allowed values for this property are: “CUSTOM_SQL_TOOL”, “BUILT_IN_SQL_TOOLS”, “CUSTOMIZABLE_REPORTING_TOOLS”, “GENAI_SQL_ASSISTANT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this DatabaseToolsMcpToolsetSummary.
Return type:	str

version¶

[Required] Gets the version of this DatabaseToolsMcpToolsetSummary. The toolset version

Returns:	The version of this DatabaseToolsMcpToolsetSummary.
Return type:	int