CreateDatabaseToolsMcpToolsetCustomSqlToolDetails¶

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

Bases: oci.database_tools.models.create_database_tools_mcp_toolset_details.CreateDatabaseToolsMcpToolsetDetails

Details for the new Database Tools MCP Toolset.

Attributes

`DEFAULT_EXECUTION_TYPE_ASYNCHRONOUS`	A constant which can be used with the default_execution_type property of a CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
`DEFAULT_EXECUTION_TYPE_SYNCHRONOUS`	A constant which can be used with the default_execution_type property of a CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
`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`	Gets the allowed_roles of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateDatabaseToolsMcpToolsetDetails.
`database_tools_mcp_server_id`	[Required] Gets the database_tools_mcp_server_id of this CreateDatabaseToolsMcpToolsetDetails.
`default_execution_type`	Gets the default_execution_type of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
`defined_tags`	Gets the defined_tags of this CreateDatabaseToolsMcpToolsetDetails.
`description`	Gets the description of this CreateDatabaseToolsMcpToolsetDetails.
`display_name`	[Required] Gets the display_name of this CreateDatabaseToolsMcpToolsetDetails.
`freeform_tags`	Gets the freeform_tags of this CreateDatabaseToolsMcpToolsetDetails.
`locks`	Gets the locks of this CreateDatabaseToolsMcpToolsetDetails.
`source`	[Required] Gets the source of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
`tool_description`	Gets the tool_description of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
`tool_name`	[Required] Gets the tool_name of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
`type`	[Required] Gets the type of this CreateDatabaseToolsMcpToolsetDetails.
`variables`	Gets the variables of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
`version`	[Required] Gets the version of this CreateDatabaseToolsMcpToolsetDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateDatabaseToolsMcpToolsetCustomSqlToolDetails 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 CreateDatabaseToolsMcpToolsetCustomSqlToolDetails. 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 CreateDatabaseToolsMcpToolsetCustomSqlToolDetails. This constant has a value of “SYNCHRONOUS”

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 CreateDatabaseToolsMcpToolsetCustomSqlToolDetails 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:

version (int) – The value to assign to the version property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
display_name (str) – The value to assign to the display_name property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
database_tools_mcp_server_id (str) – The value to assign to the database_tools_mcp_server_id property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
description (str) – The value to assign to the description property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
type (str) – The value to assign to the type property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails. Allowed values for this property are: “CUSTOM_SQL_TOOL”, “BUILT_IN_SQL_TOOLS”, “CUSTOMIZABLE_REPORTING_TOOLS”, “GENAI_SQL_ASSISTANT”
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
tool_description (str) – The value to assign to the tool_description property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
tool_name (str) – The value to assign to the tool_name property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
source (oci.database_tools.models.DatabaseToolsCustomSqlToolToolsetSource) – The value to assign to the source property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
variables (list[oci.database_tools.models.DatabaseToolsMcpToolsetCustomSqlToolVariable]) – The value to assign to the variables property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
allowed_roles (list[str]) – The value to assign to the allowed_roles property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
default_execution_type (str) – The value to assign to the default_execution_type property of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails. Allowed values for this property are: “SYNCHRONOUS”, “ASYNCHRONOUS”

allowed_roles¶

Gets the allowed_roles of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails. The roles granted access to the MCP tool generated by this toolset

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

compartment_id¶

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

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

database_tools_mcp_server_id¶

[Required] Gets the database_tools_mcp_server_id of this CreateDatabaseToolsMcpToolsetDetails. The OCID of the Database Tools MCP Server

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

default_execution_type¶

Gets the default_execution_type of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails. 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”

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

defined_tags¶

Gets the defined_tags of this CreateDatabaseToolsMcpToolsetDetails. 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 CreateDatabaseToolsMcpToolsetDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateDatabaseToolsMcpToolsetDetails. A human readable description of the Database Tools MCP toolset.

Returns:	The description of this CreateDatabaseToolsMcpToolsetDetails.
Return type:	str

display_name¶

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

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

freeform_tags¶

Gets the freeform_tags of this CreateDatabaseToolsMcpToolsetDetails. 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 CreateDatabaseToolsMcpToolsetDetails.
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.

locks¶

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

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

source¶

[Required] Gets the source of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.

Returns:	The source of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
Return type:	oci.database_tools.models.DatabaseToolsCustomSqlToolToolsetSource

tool_description¶

Gets the tool_description of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails. 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 CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
Return type:	str

tool_name¶

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

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

type¶

[Required] Gets the type of this CreateDatabaseToolsMcpToolsetDetails. 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”

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

variables¶

Gets the variables of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails. The variables to use with the query

Returns:	The variables of this CreateDatabaseToolsMcpToolsetCustomSqlToolDetails.
Return type:	list[oci.database_tools.models.DatabaseToolsMcpToolsetCustomSqlToolVariable]

version¶

[Required] Gets the version of this CreateDatabaseToolsMcpToolsetDetails. The MCP toolset version

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