Class: OCI::DatabaseTools::Models::CreateDatabaseToolsMcpToolsetCustomSqlToolDetails

Inherits:
CreateDatabaseToolsMcpToolsetDetails show all
Defined in:
lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb

Overview

Details for the new Database Tools MCP Toolset.

Constant Summary collapse

DEFAULT_EXECUTION_TYPE_ENUM = 
[
  DEFAULT_EXECUTION_TYPE_SYNCHRONOUS = 'SYNCHRONOUS'.freeze,
  DEFAULT_EXECUTION_TYPE_ASYNCHRONOUS = 'ASYNCHRONOUS'.freeze
].freeze

Constants inherited from CreateDatabaseToolsMcpToolsetDetails

OCI::DatabaseTools::Models::CreateDatabaseToolsMcpToolsetDetails::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateDatabaseToolsMcpToolsetDetails

#compartment_id, #database_tools_mcp_server_id, #defined_tags, #description, #display_name, #freeform_tags, #locks, #type, #version

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateDatabaseToolsMcpToolsetDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateDatabaseToolsMcpToolsetCustomSqlToolDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 110

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'CUSTOM_SQL_TOOL'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.tool_description = attributes[:'toolDescription'] if attributes[:'toolDescription']

  raise 'You cannot provide both :toolDescription and :tool_description' if attributes.key?(:'toolDescription') && attributes.key?(:'tool_description')

  self.tool_description = attributes[:'tool_description'] if attributes[:'tool_description']

  self.tool_name = attributes[:'toolName'] if attributes[:'toolName']

  raise 'You cannot provide both :toolName and :tool_name' if attributes.key?(:'toolName') && attributes.key?(:'tool_name')

  self.tool_name = attributes[:'tool_name'] if attributes[:'tool_name']

  self.source = attributes[:'source'] if attributes[:'source']

  self.variables = attributes[:'variables'] if attributes[:'variables']

  self.allowed_roles = attributes[:'allowedRoles'] if attributes[:'allowedRoles']

  raise 'You cannot provide both :allowedRoles and :allowed_roles' if attributes.key?(:'allowedRoles') && attributes.key?(:'allowed_roles')

  self.allowed_roles = attributes[:'allowed_roles'] if attributes[:'allowed_roles']

  self.default_execution_type = attributes[:'defaultExecutionType'] if attributes[:'defaultExecutionType']

  raise 'You cannot provide both :defaultExecutionType and :default_execution_type' if attributes.key?(:'defaultExecutionType') && attributes.key?(:'default_execution_type')

  self.default_execution_type = attributes[:'default_execution_type'] if attributes[:'default_execution_type']
end

Instance Attribute Details

#allowed_roles ⇒ Array<String>

The roles granted access to the MCP tool generated by this toolset

Returns:

  • (Array<String>) 


35
36
37
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 35

def allowed_roles
  @allowed_roles
end

#default_execution_type ⇒ String

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.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 42

def default_execution_type
  @default_execution_type
end

#source ⇒ OCI::DatabaseTools::Models::DatabaseToolsCustomSqlToolToolsetSource

This attribute is required.

Returns:



27
28
29
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 27

def source
  @source
end

#tool_description ⇒ String

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:

  • (String) 


19
20
21
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 19

def tool_description
  @tool_description
end

#tool_name ⇒ String

[Required] Name of the tool returned by the MCP Server

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 23

def tool_name
  @tool_name
end

#variables ⇒ Array<OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetCustomSqlToolVariable>

The variables to use with the query

Returns:



31
32
33
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 31

def variables
  @variables
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'version': :'version',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'database_tools_mcp_server_id': :'databaseToolsMcpServerId',
    'description': :'description',
    'type': :'type',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'locks': :'locks',
    'tool_description': :'toolDescription',
    'tool_name': :'toolName',
    'source': :'source',
    'variables': :'variables',
    'allowed_roles': :'allowedRoles',
    'default_execution_type': :'defaultExecutionType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'version': :'Integer',
    'compartment_id': :'String',
    'display_name': :'String',
    'database_tools_mcp_server_id': :'String',
    'description': :'String',
    'type': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>',
    'tool_description': :'String',
    'tool_name': :'String',
    'source': :'OCI::DatabaseTools::Models::DatabaseToolsCustomSqlToolToolsetSource',
    'variables': :'Array<OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetCustomSqlToolVariable>',
    'allowed_roles': :'Array<String>',
    'default_execution_type': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 164

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    version == other.version &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    database_tools_mcp_server_id == other.database_tools_mcp_server_id &&
    description == other.description &&
    type == other.type &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    locks == other.locks &&
    tool_description == other.tool_description &&
    tool_name == other.tool_name &&
    source == other.source &&
    variables == other.variables &&
    allowed_roles == other.allowed_roles &&
    default_execution_type == other.default_execution_type
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 208

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


188
189
190
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 197

def hash
  [version, compartment_id, display_name, database_tools_mcp_server_id, description, type, defined_tags, freeform_tags, locks, tool_description, tool_name, source, variables, allowed_roles, default_execution_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 241

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



235
236
237
 
# File 'lib/oci/database_tools/models/create_database_tools_mcp_toolset_custom_sql_tool_details.rb', line 235

def to_s
  to_hash.to_s
end