DatabaseToolsMcpToolsetCustomSqlTool¶

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

Bases: DatabaseToolsMcpToolset

Allows the creation, configuration and management of an McpToolset.

Attributes:

`DEFAULT_EXECUTION_TYPE_ASYNCHRONOUS`	A constant which can be used with the default_execution_type property of a DatabaseToolsMcpToolsetCustomSqlTool.
`DEFAULT_EXECUTION_TYPE_SYNCHRONOUS`	A constant which can be used with the default_execution_type property of a DatabaseToolsMcpToolsetCustomSqlTool.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset.
`TYPE_BUILT_IN_SQL_TOOLS`	A constant which can be used with the type property of a DatabaseToolsMcpToolset.
`TYPE_CUSTOMIZABLE_REPORTING_TOOLS`	A constant which can be used with the type property of a DatabaseToolsMcpToolset.
`TYPE_CUSTOM_SQL_TOOL`	A constant which can be used with the type property of a DatabaseToolsMcpToolset.
`TYPE_GENAI_SQL_ASSISTANT`	A constant which can be used with the type property of a DatabaseToolsMcpToolset.
`allowed_roles`	Gets the allowed_roles of this DatabaseToolsMcpToolsetCustomSqlTool.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseToolsMcpToolset.
`database_tools_mcp_server_id`	[Required] Gets the database_tools_mcp_server_id of this DatabaseToolsMcpToolset.
`default_execution_type`	Gets the default_execution_type of this DatabaseToolsMcpToolsetCustomSqlTool.
`defined_tags`	Gets the defined_tags of this DatabaseToolsMcpToolset.
`description`	Gets the description of this DatabaseToolsMcpToolset.
`display_name`	[Required] Gets the display_name of this DatabaseToolsMcpToolset.
`freeform_tags`	Gets the freeform_tags of this DatabaseToolsMcpToolset.
`id`	[Required] Gets the id of this DatabaseToolsMcpToolset.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseToolsMcpToolset.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseToolsMcpToolset.
`locks`	Gets the locks of this DatabaseToolsMcpToolset.
`source`	[Required] Gets the source of this DatabaseToolsMcpToolsetCustomSqlTool.
`system_tags`	Gets the system_tags of this DatabaseToolsMcpToolset.
`time_created`	[Required] Gets the time_created of this DatabaseToolsMcpToolset.
`time_updated`	[Required] Gets the time_updated of this DatabaseToolsMcpToolset.
`tool_description`	Gets the tool_description of this DatabaseToolsMcpToolsetCustomSqlTool.
`tool_name`	[Required] Gets the tool_name of this DatabaseToolsMcpToolsetCustomSqlTool.
`type`	[Required] Gets the type of this DatabaseToolsMcpToolset.
`variables`	Gets the variables of this DatabaseToolsMcpToolsetCustomSqlTool.
`version`	[Required] Gets the version of this DatabaseToolsMcpToolset.

Methods:

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpToolset. This constant has a value of “UPDATING”

TYPE_BUILT_IN_SQL_TOOLS = 'BUILT_IN_SQL_TOOLS'¶: A constant which can be used with the type property of a DatabaseToolsMcpToolset. This constant has a value of “BUILT_IN_SQL_TOOLS”

TYPE_CUSTOMIZABLE_REPORTING_TOOLS = 'CUSTOMIZABLE_REPORTING_TOOLS'¶: A constant which can be used with the type property of a DatabaseToolsMcpToolset. This constant has a value of “CUSTOMIZABLE_REPORTING_TOOLS”

TYPE_CUSTOM_SQL_TOOL = 'CUSTOM_SQL_TOOL'¶: A constant which can be used with the type property of a DatabaseToolsMcpToolset. This constant has a value of “CUSTOM_SQL_TOOL”

TYPE_GENAI_SQL_ASSISTANT = 'GENAI_SQL_ASSISTANT'¶: A constant which can be used with the type property of a DatabaseToolsMcpToolset. This constant has a value of “GENAI_SQL_ASSISTANT”

__init__(**kwargs)¶

Initializes a new DatabaseToolsMcpToolsetCustomSqlTool 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 DatabaseToolsMcpToolsetCustomSqlTool.
version (int) – The value to assign to the version property of this DatabaseToolsMcpToolsetCustomSqlTool.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsMcpToolsetCustomSqlTool.
type (str) – The value to assign to the type property of this DatabaseToolsMcpToolsetCustomSqlTool. 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 DatabaseToolsMcpToolsetCustomSqlTool.
description (str) – The value to assign to the description property of this DatabaseToolsMcpToolsetCustomSqlTool.
database_tools_mcp_server_id (str) – The value to assign to the database_tools_mcp_server_id property of this DatabaseToolsMcpToolsetCustomSqlTool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsMcpToolsetCustomSqlTool. 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 DatabaseToolsMcpToolsetCustomSqlTool.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsMcpToolsetCustomSqlTool.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsMcpToolsetCustomSqlTool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsMcpToolsetCustomSqlTool.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsMcpToolsetCustomSqlTool.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsMcpToolsetCustomSqlTool.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsMcpToolsetCustomSqlTool.
tool_name (str) – The value to assign to the tool_name property of this DatabaseToolsMcpToolsetCustomSqlTool.
tool_description (str) – The value to assign to the tool_description property of this DatabaseToolsMcpToolsetCustomSqlTool.
source (oci.database_tools.models.DatabaseToolsCustomSqlToolToolsetSource) – The value to assign to the source property of this DatabaseToolsMcpToolsetCustomSqlTool.
variables (list[oci.database_tools.models.DatabaseToolsMcpToolsetCustomSqlToolVariable]) – The value to assign to the variables property of this DatabaseToolsMcpToolsetCustomSqlTool.
allowed_roles (list[str]) – The value to assign to the allowed_roles property of this DatabaseToolsMcpToolsetCustomSqlTool.
default_execution_type (str) – The value to assign to the default_execution_type property of this DatabaseToolsMcpToolsetCustomSqlTool. 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’.

property allowed_roles¶

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

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

property compartment_id¶

[Required] Gets the compartment_id of this DatabaseToolsMcpToolset. The OCID of the compartment to move the Database Tools MCP Toolset to.

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

property database_tools_mcp_server_id¶

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

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

property default_execution_type¶

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

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

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

property freeform_tags¶

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

property id¶

[Required] Gets the id of this DatabaseToolsMcpToolset. The OCID of the Database Tools MCP Toolsets.

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

property lifecycle_details¶

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseToolsMcpToolset. 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 DatabaseToolsMcpToolset.
Return type: str

property locks¶

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

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

property source¶

[Required] Gets the source of this DatabaseToolsMcpToolsetCustomSqlTool.

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

property system_tags¶

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

property time_created¶

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

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

property time_updated¶

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

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

property tool_description¶

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

property tool_name¶

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

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

property type¶

[Required] Gets the type of this DatabaseToolsMcpToolset. 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 DatabaseToolsMcpToolset.
Return type: str

property variables¶

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

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

property version¶

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

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