Module: OpenAI::Models::Beta::McpTransportParam

Extended by:
Internal::Type::Union
Defined in:
lib/openai/models/beta/mcp_transport_param.rb,
sig/openai/models/beta/mcp_transport_param.rbs

Overview

The transport used to connect to an MCP server.

Defined Under Namespace

Classes: HTTP, Stdio

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

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

Methods included from Internal::Type::Converter

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

Class Method Details

.variants ⇒ Array(OpenAI::Models::Beta::McpTransportParam::HTTP, OpenAI::Models::Beta::McpTransportParam::Stdio)

Returns:




# File 'lib/openai/models/beta/mcp_transport_param.rb', line 118

Instance Method Details

#initialize(server_url:, authorization: nil, headers: nil, type: :http) ⇒ Object

Connects to an MCP server over HTTP.

Parameters:

  • server_url (String) —

    The URL of the MCP server.

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

    The authorization value sent to the MCP server, if any.

  • headers (Hash{Symbol=>String}, nil) (defaults to: nil) —

    Additional HTTP headers sent to the MCP server.

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

    The type of the object. Always http.




# File 'lib/openai/models/beta/mcp_transport_param.rb', line 43

#self?.variants ⇒ ::Array[OpenAI::Models::Beta::mcp_transport_param]

Returns:

  • (::Array[OpenAI::Models::Beta::mcp_transport_param]) 


85
 
# File 'sig/openai/models/beta/mcp_transport_param.rbs', line 85

def self?.variants: -> ::Array[OpenAI::Models::Beta::mcp_transport_param]