Class: OCI::DatabaseTools::Models::DatabaseToolsMcpToolsetCustomSqlTool

Inherits:
DatabaseToolsMcpToolset show all
Defined in:
lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb

Overview

Allows the creation, configuration and management of an McpToolset.

Constant Summary collapse

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

Constants inherited from DatabaseToolsMcpToolset

OCI::DatabaseTools::Models::DatabaseToolsMcpToolset::LIFECYCLE_STATE_ENUM, OCI::DatabaseTools::Models::DatabaseToolsMcpToolset::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DatabaseToolsMcpToolset

#compartment_id, #database_tools_mcp_server_id, #defined_tags, #description, #display_name, #freeform_tags, #id, #lifecycle_details, #lifecycle_state, #locks, #system_tags, #time_created, #time_updated, #type, #version

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DatabaseToolsMcpToolset

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DatabaseToolsMcpToolsetCustomSqlTool

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 130

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_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.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.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>) 


37
38
39
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 37

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) 


44
45
46
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 44

def default_execution_type
  @default_execution_type
end

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

This attribute is required.

Returns:



29
30
31
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 29

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) 


25
26
27
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 25

def tool_description
  @tool_description
end

#tool_name ⇒ String

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

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 21

def tool_name
  @tool_name
end

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

The variables to use with the query

Returns:



33
34
35
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 33

def variables
  @variables
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 47

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'version': :'version',
    'compartment_id': :'compartmentId',
    'type': :'type',
    'display_name': :'displayName',
    'description': :'description',
    'database_tools_mcp_server_id': :'databaseToolsMcpServerId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags',
    'system_tags': :'systemTags',
    'locks': :'locks',
    'tool_name': :'toolName',
    'tool_description': :'toolDescription',
    'source': :'source',
    'variables': :'variables',
    'allowed_roles': :'allowedRoles',
    'default_execution_type': :'defaultExecutionType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'version': :'Integer',
    'compartment_id': :'String',
    'type': :'String',
    'display_name': :'String',
    'description': :'String',
    'database_tools_mcp_server_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::DatabaseTools::Models::ResourceLock>',
    'tool_name': :'String',
    'tool_description': :'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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 189

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

  self.class == other.class &&
    id == other.id &&
    version == other.version &&
    compartment_id == other.compartment_id &&
    type == other.type &&
    display_name == other.display_name &&
    description == other.description &&
    database_tools_mcp_server_id == other.database_tools_mcp_server_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags &&
    system_tags == other.system_tags &&
    locks == other.locks &&
    tool_name == other.tool_name &&
    tool_description == other.tool_description &&
    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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 239

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


219
220
221
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 219

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 228

def hash
  [id, version, compartment_id, type, display_name, description, database_tools_mcp_server_id, lifecycle_state, lifecycle_details, time_created, time_updated, defined_tags, freeform_tags, system_tags, locks, tool_name, tool_description, 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



272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 272

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



266
267
268
 
# File 'lib/oci/database_tools/models/database_tools_mcp_toolset_custom_sql_tool.rb', line 266

def to_s
  to_hash.to_s
end