Class: OpenAI::Models::Responses::ResponseOutputItem::McpListTools::Tool

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_output_item.rb,
sig/openai/models/responses/response_output_item.rbs

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, 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:, error: nil, type: :mcp_list_tools) ⇒ Object

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

A list of tools available on an MCP server.

Parameters:

  • id (String) —

    The unique ID of the list.

  • server_label (String) —

    The label of the MCP server.

  • tools (Array<OpenAI::Models::Responses::ResponseOutputItem::McpListTools::Tool>) —

    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.



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/openai/models/responses/response_output_item.rb', line 627

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::ResponseOutputItem::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.

Parameters:

  • value (top, nil)

Returns:

  • (Object, nil) 


644
 
# File 'lib/openai/models/responses/response_output_item.rb', line 644

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

#description ⇒ String?

The description of the tool.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


650
 
# File 'lib/openai/models/responses/response_output_item.rb', line 650

optional :description, String, nil?: true

#input_schema ⇒ Object

The JSON schema describing the tool's input.

Parameters:

  • value (top)

Returns:

  • (Object) 


632
 
# File 'lib/openai/models/responses/response_output_item.rb', line 632

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

#name ⇒ String

The name of the tool.

Parameters:

  • value (String)

Returns:

  • (String) 


638
 
# File 'lib/openai/models/responses/response_output_item.rb', line 638

required :name, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


495
 
# File 'sig/openai/models/responses/response_output_item.rbs', line 495

def to_hash: -> {