UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails

class oci.database_tools.models.UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails(**kwargs)

Bases: UpdateDatabaseToolsMcpToolsetDetails

Database Tools MCP Toolset information to be updated for the CUSTOM_SQL_TOOL type.

Attributes:

DEFAULT_EXECUTION_TYPE_ASYNCHRONOUS

A constant which can be used with the default_execution_type property of a UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

DEFAULT_EXECUTION_TYPE_SYNCHRONOUS

A constant which can be used with the default_execution_type property of a UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

TYPE_BUILT_IN_SQL_TOOLS

A constant which can be used with the type property of a UpdateDatabaseToolsMcpToolsetDetails.

TYPE_CUSTOMIZABLE_REPORTING_TOOLS

A constant which can be used with the type property of a UpdateDatabaseToolsMcpToolsetDetails.

TYPE_CUSTOM_SQL_TOOL

A constant which can be used with the type property of a UpdateDatabaseToolsMcpToolsetDetails.

TYPE_GENAI_SQL_ASSISTANT

A constant which can be used with the type property of a UpdateDatabaseToolsMcpToolsetDetails.

allowed_roles

Gets the allowed_roles of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

default_execution_type

Gets the default_execution_type of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

defined_tags

Gets the defined_tags of this UpdateDatabaseToolsMcpToolsetDetails.

description

Gets the description of this UpdateDatabaseToolsMcpToolsetDetails.

display_name

Gets the display_name of this UpdateDatabaseToolsMcpToolsetDetails.

freeform_tags

Gets the freeform_tags of this UpdateDatabaseToolsMcpToolsetDetails.

source

Gets the source of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

tool_description

Gets the tool_description of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

tool_name

Gets the tool_name of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

type

[Required] Gets the type of this UpdateDatabaseToolsMcpToolsetDetails.

variables

Gets the variables of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

version

Gets the version of this UpdateDatabaseToolsMcpToolsetDetails.

Methods:

__init__(**kwargs)

Initializes a new UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails 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 UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails. 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 UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails. This constant has a value of “SYNCHRONOUS”

TYPE_BUILT_IN_SQL_TOOLS = 'BUILT_IN_SQL_TOOLS'

A constant which can be used with the type property of a UpdateDatabaseToolsMcpToolsetDetails. 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 UpdateDatabaseToolsMcpToolsetDetails. 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 UpdateDatabaseToolsMcpToolsetDetails. 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 UpdateDatabaseToolsMcpToolsetDetails. This constant has a value of “GENAI_SQL_ASSISTANT”

__init__(**kwargs)

Initializes a new UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails 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 UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • display_name (str) – The value to assign to the display_name property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • description (str) – The value to assign to the description property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • type (str) – The value to assign to the type property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails. Allowed values for this property are: “CUSTOM_SQL_TOOL”, “BUILT_IN_SQL_TOOLS”, “CUSTOMIZABLE_REPORTING_TOOLS”, “GENAI_SQL_ASSISTANT”

  • tool_description (str) – The value to assign to the tool_description property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • tool_name (str) – The value to assign to the tool_name property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • source (oci.database_tools.models.DatabaseToolsCustomSqlToolToolsetSource) – The value to assign to the source property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • variables (list[oci.database_tools.models.DatabaseToolsMcpToolsetCustomSqlToolVariable]) – The value to assign to the variables property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • allowed_roles (list[str]) – The value to assign to the allowed_roles property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

  • default_execution_type (str) – The value to assign to the default_execution_type property of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails. Allowed values for this property are: “SYNCHRONOUS”, “ASYNCHRONOUS”

property allowed_roles

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

Returns

The allowed_roles of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

Return type

list[str]

property default_execution_type

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

Return type

str

property defined_tags

Gets the defined_tags of this UpdateDatabaseToolsMcpToolsetDetails. 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 UpdateDatabaseToolsMcpToolsetDetails.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this UpdateDatabaseToolsMcpToolsetDetails.

Return type

str

property display_name

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

Returns

The display_name of this UpdateDatabaseToolsMcpToolsetDetails.

Return type

str

property freeform_tags

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

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 source

Gets the source of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

Returns

The source of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

Return type

oci.database_tools.models.DatabaseToolsCustomSqlToolToolsetSource

property tool_description

Gets the tool_description of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails. 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 UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

Return type

str

property tool_name

Gets the tool_name of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails. Name of the tool returned by the MCP Server

Returns

The tool_name of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

Return type

str

property type

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

Return type

str

property variables

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

Returns

The variables of this UpdateDatabaseToolsMcpToolsetCustomSqlToolDetails.

Return type

list[oci.database_tools.models.DatabaseToolsMcpToolsetCustomSqlToolVariable]

property version

Gets the version of this UpdateDatabaseToolsMcpToolsetDetails. The MCP toolset version

Returns

The version of this UpdateDatabaseToolsMcpToolsetDetails.

Return type

int