DatabaseToolsMcpServer¶

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

Bases: object

Allows the creation, configuration and management of an MCP server.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpServer.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpServer.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpServer.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpServer.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpServer.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpServer.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpServer.
`RUNTIME_IDENTITY_AUTHENTICATED_PRINCIPAL`	A constant which can be used with the runtime_identity property of a DatabaseToolsMcpServer.
`RUNTIME_IDENTITY_RESOURCE_PRINCIPAL`	A constant which can be used with the runtime_identity property of a DatabaseToolsMcpServer.
`TYPE_DEFAULT`	A constant which can be used with the type property of a DatabaseToolsMcpServer.
`access_token_expiry_in_seconds`	Gets the access_token_expiry_in_seconds of this DatabaseToolsMcpServer.
`built_in_roles`	Gets the built_in_roles of this DatabaseToolsMcpServer.
`compartment_id`	[Required] Gets the compartment_id of this DatabaseToolsMcpServer.
`custom_roles`	Gets the custom_roles of this DatabaseToolsMcpServer.
`database_tools_connection_id`	[Required] Gets the database_tools_connection_id of this DatabaseToolsMcpServer.
`defined_tags`	Gets the defined_tags of this DatabaseToolsMcpServer.
`description`	Gets the description of this DatabaseToolsMcpServer.
`display_name`	[Required] Gets the display_name of this DatabaseToolsMcpServer.
`endpoints`	Gets the endpoints of this DatabaseToolsMcpServer.
`freeform_tags`	Gets the freeform_tags of this DatabaseToolsMcpServer.
`id`	[Required] Gets the id of this DatabaseToolsMcpServer.
`lifecycle_details`	Gets the lifecycle_details of this DatabaseToolsMcpServer.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DatabaseToolsMcpServer.
`locks`	Gets the locks of this DatabaseToolsMcpServer.
`refresh_token_expiry_in_seconds`	Gets the refresh_token_expiry_in_seconds of this DatabaseToolsMcpServer.
`related_resource`	[Required] Gets the related_resource of this DatabaseToolsMcpServer.
`runtime_identity`	[Required] Gets the runtime_identity of this DatabaseToolsMcpServer.
`system_tags`	Gets the system_tags of this DatabaseToolsMcpServer.
`time_created`	[Required] Gets the time_created of this DatabaseToolsMcpServer.
`time_updated`	[Required] Gets the time_updated of this DatabaseToolsMcpServer.
`type`	[Required] Gets the type of this DatabaseToolsMcpServer.

Methods

`__init__`(**kwargs)	Initializes a new DatabaseToolsMcpServer 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.

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

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

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

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

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a DatabaseToolsMcpServer. This constant has a value of “NEEDS_ATTENTION”

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

RUNTIME_IDENTITY_AUTHENTICATED_PRINCIPAL = 'AUTHENTICATED_PRINCIPAL'¶: A constant which can be used with the runtime_identity property of a DatabaseToolsMcpServer. This constant has a value of “AUTHENTICATED_PRINCIPAL”

RUNTIME_IDENTITY_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'¶: A constant which can be used with the runtime_identity property of a DatabaseToolsMcpServer. This constant has a value of “RESOURCE_PRINCIPAL”

TYPE_DEFAULT = 'DEFAULT'¶: A constant which can be used with the type property of a DatabaseToolsMcpServer. This constant has a value of “DEFAULT”

__init__(**kwargs)¶

Initializes a new DatabaseToolsMcpServer object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

DatabaseToolsMcpServerDefault

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 DatabaseToolsMcpServer.
type (str) – The value to assign to the type property of this DatabaseToolsMcpServer. Allowed values for this property are: “DEFAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this DatabaseToolsMcpServer.
display_name (str) – The value to assign to the display_name property of this DatabaseToolsMcpServer.
description (str) – The value to assign to the description property of this DatabaseToolsMcpServer.
database_tools_connection_id (str) – The value to assign to the database_tools_connection_id property of this DatabaseToolsMcpServer.
endpoints (list[oci.database_tools.models.DatabaseToolsMcpServerEndpoint]) – The value to assign to the endpoints property of this DatabaseToolsMcpServer.
built_in_roles (list[oci.database_tools.models.DatabaseToolsMcpServerBuiltInRole]) – The value to assign to the built_in_roles property of this DatabaseToolsMcpServer.
custom_roles (list[oci.database_tools.models.DatabaseToolsMcpServerCustomRole]) – The value to assign to the custom_roles property of this DatabaseToolsMcpServer.
access_token_expiry_in_seconds (int) – The value to assign to the access_token_expiry_in_seconds property of this DatabaseToolsMcpServer.
refresh_token_expiry_in_seconds (int) – The value to assign to the refresh_token_expiry_in_seconds property of this DatabaseToolsMcpServer.
related_resource (oci.database_tools.models.DatabaseToolsMcpServerRelatedResource) – The value to assign to the related_resource property of this DatabaseToolsMcpServer.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DatabaseToolsMcpServer. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, ‘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 DatabaseToolsMcpServer.
time_created (datetime) – The value to assign to the time_created property of this DatabaseToolsMcpServer.
time_updated (datetime) – The value to assign to the time_updated property of this DatabaseToolsMcpServer.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DatabaseToolsMcpServer.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DatabaseToolsMcpServer.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DatabaseToolsMcpServer.
runtime_identity (str) – The value to assign to the runtime_identity property of this DatabaseToolsMcpServer. Allowed values for this property are: “AUTHENTICATED_PRINCIPAL”, “RESOURCE_PRINCIPAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
locks (list[oci.database_tools.models.ResourceLock]) – The value to assign to the locks property of this DatabaseToolsMcpServer.

access_token_expiry_in_seconds¶

Gets the access_token_expiry_in_seconds of this DatabaseToolsMcpServer. Access token expiry in seconds

Returns:	The access_token_expiry_in_seconds of this DatabaseToolsMcpServer.
Return type:	int

built_in_roles¶

Gets the built_in_roles of this DatabaseToolsMcpServer. Built-in roles associated with the MCP Server.

Returns:	The built_in_roles of this DatabaseToolsMcpServer.
Return type:	list[oci.database_tools.models.DatabaseToolsMcpServerBuiltInRole]

compartment_id¶

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

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

custom_roles¶

Gets the custom_roles of this DatabaseToolsMcpServer. Custom roles associated with the MCP Server.

Returns:	The custom_roles of this DatabaseToolsMcpServer.
Return type:	list[oci.database_tools.models.DatabaseToolsMcpServerCustomRole]

database_tools_connection_id¶

[Required] Gets the database_tools_connection_id of this DatabaseToolsMcpServer. The OCID of the related Database Tools connection.

Returns:	The database_tools_connection_id of this DatabaseToolsMcpServer.
Return type:	str

defined_tags¶

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

description¶

Gets the description of this DatabaseToolsMcpServer. A human-readable description of the Database Tools MCP server.

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

display_name¶

[Required] Gets the display_name of this DatabaseToolsMcpServer. A meaningful, human-readable label displayed to end users. Not required to be unique and can be changed after creation. Do not include confidential information.

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

endpoints¶

Gets the endpoints of this DatabaseToolsMcpServer. Invoke endpoints for the MCP server.

Returns:	The endpoints of this DatabaseToolsMcpServer.
Return type:	list[oci.database_tools.models.DatabaseToolsMcpServerEndpoint]

freeform_tags¶

Gets the freeform_tags of this DatabaseToolsMcpServer. 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 DatabaseToolsMcpServer.
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 DatabaseToolsMcpServer. The OCID of the Database Tools MCP server.

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

lifecycle_details¶

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DatabaseToolsMcpServer. The current state of the Database Tools MCP server.

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

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

locks¶

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

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

refresh_token_expiry_in_seconds¶

Gets the refresh_token_expiry_in_seconds of this DatabaseToolsMcpServer. Refresh token expiry in seconds

Returns:	The refresh_token_expiry_in_seconds of this DatabaseToolsMcpServer.
Return type:	int

related_resource¶

[Required] Gets the related_resource of this DatabaseToolsMcpServer.

Returns:	The related_resource of this DatabaseToolsMcpServer.
Return type:	oci.database_tools.models.DatabaseToolsMcpServerRelatedResource

runtime_identity¶

[Required] Gets the runtime_identity of this DatabaseToolsMcpServer. Specifies the identity used when accessing OCI resources at runtime. AUTHENTICATED_PRINCIPAL to use the caller’s identity (On-Behalf-Of token), or RESOURCE_PRINCIPAL to use the MCP Server’s resource principal (RPST).

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

Returns:	The runtime_identity of this DatabaseToolsMcpServer.
Return type:	str

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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

type¶

[Required] Gets the type of this DatabaseToolsMcpServer. The Database Tools MCP server type.

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

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