Class: OpenAI::Models::Responses::ResponseItem::McpListTools::Tool

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_item.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, 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, #dump, dump, #inspect, inspect, 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: , error: nil, type: :mcp_list_tools) ⇒ Object

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

A list of tools available on an MCP server.

Parameters:

  • id (String) (defaults to: ) —

    The unique ID of the list.

  • server_label (String) (defaults to: ) —

    The label of the MCP server.

  • tools (Array<OpenAI::Models::Responses::ResponseItem::McpListTools::Tool>) (defaults to: ) —

    The tools available on the server.

  • error (String, nil) (defaults to: nil) —

    Error message if the server could not list tools.

  • type (Symbol, :mcp_list_tools) (defaults to: :mcp_list_tools) —

    The type of the item. Always ‘mcp_list_tools`.



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/openai/models/responses/response_item.rb', line 343

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::Responses::ResponseItem::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) 


360
 
# File 'lib/openai/models/responses/response_item.rb', line 360

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

#description ⇒ String?

The description of the tool.

Returns:

  • (String, nil) 


366
 
# File 'lib/openai/models/responses/response_item.rb', line 366

optional :description, String, nil?: true

#input_schema ⇒ Object

The JSON schema describing the tool’s input.

Returns:

  • (Object) 


348
 
# File 'lib/openai/models/responses/response_item.rb', line 348

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

#name ⇒ String

The name of the tool.

Returns:

  • (String) 


354
 
# File 'lib/openai/models/responses/response_item.rb', line 354

required :name, String