Class: OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools::Tool

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/beta_response_output_item.rb

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, server_label:, tools:, agent: nil, error: nil, type: :mcp_list_tools) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools for more details.

A list of tools available on an MCP server.

Parameters:



1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
 
# File 'lib/openai/models/beta/beta_response_output_item.rb', line 1257

class Tool < OpenAI::Internal::Type::BaseModel
  # @!attribute input_schema
  #   The JSON schema describing the tool's input.
  #
  #   @return [Object]
  required :input_schema, OpenAI::Internal::Type::Unknown

  # @!attribute name
  #   The name of the tool.
  #
  #   @return [String]
  required :name, String

  # @!attribute annotations
  #   Additional annotations about the tool.
  #
  #   @return [Object, nil]
  optional :annotations, OpenAI::Internal::Type::Unknown, nil?: true

  # @!attribute description
  #   The description of the tool.
  #
  #   @return [String, nil]
  optional :description, String, nil?: true

  # @!method initialize(input_schema:, name:, annotations: nil, description: nil)
  #   Some parameter documentations has been truncated, see
  #   {OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools::Tool} for more
  #   details.
  #
  #   A tool available on an MCP server.
  #
  #   @param input_schema [Object] The JSON schema describing the tool's input.
  #
  #   @param name [String] The name of the tool.
  #
  #   @param annotations [Object, nil] Additional annotations about the tool.
  #
  #   @param description [String, nil] The description of the tool.
end

Instance Attribute Details

#annotations ⇒ Object?

Additional annotations about the tool.

Returns:

  • (Object, nil) 


1274
 
# File 'lib/openai/models/beta/beta_response_output_item.rb', line 1274

optional :annotations, OpenAI::Internal::Type::Unknown, nil?: true

#description ⇒ String?

The description of the tool.

Returns:

  • (String, nil) 


1280
 
# File 'lib/openai/models/beta/beta_response_output_item.rb', line 1280

optional :description, String, nil?: true

#input_schema ⇒ Object

The JSON schema describing the tool's input.

Returns:

  • (Object) 


1262
 
# File 'lib/openai/models/beta/beta_response_output_item.rb', line 1262

required :input_schema, OpenAI::Internal::Type::Unknown

#name ⇒ String

The name of the tool.

Returns:

  • (String) 


1268
 
# File 'lib/openai/models/beta/beta_response_output_item.rb', line 1268

required :name, String