Class: OpenAI::Models::Responses::ResponseInputItem::McpListTools::Tool

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_input_item.rb,
sig/openai/models/responses/response_input_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::ResponseInputItem::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::ResponseInputItem::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.



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/openai/models/responses/response_input_item.rb', line 1527

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::ResponseInputItem::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) 


1544
 
# File 'lib/openai/models/responses/response_input_item.rb', line 1544

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

#description ⇒ String?

The description of the tool.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


1550
 
# File 'lib/openai/models/responses/response_input_item.rb', line 1550

optional :description, String, nil?: true

#input_schema ⇒ Object

The JSON schema describing the tool's input.

Parameters:

  • value (top)

Returns:

  • (Object) 


1532
 
# File 'lib/openai/models/responses/response_input_item.rb', line 1532

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

#name ⇒ String

The name of the tool.

Parameters:

  • value (String)

Returns:

  • (String) 


1538
 
# File 'lib/openai/models/responses/response_input_item.rb', line 1538

required :name, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1085
 
# File 'sig/openai/models/responses/response_input_item.rbs', line 1085

def to_hash: -> {