Class: OpenAI::Models::Conversations::ConversationItem::McpCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/conversations/conversation_item.rb

Defined Under Namespace

Modules: Status

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:, arguments:, name:, server_label:, approval_request_id: nil, error: nil, output: nil, status: nil, type: :mcp_call) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Conversations::ConversationItem::McpCall for more details.

An invocation of a tool on an MCP server.

Parameters:

  • id (String) —

    The unique ID of the tool call.

  • arguments (String) —

    A JSON string of the arguments passed to the tool.

  • name (String) —

    The name of the tool that was run.

  • server_label (String) —

    The label of the MCP server running the tool.

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

    Unique identifier for the MCP tool call approval request.

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

    The error from the tool call, if any.

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

    The output from the tool call.

  • status (Symbol, OpenAI::Models::Conversations::ConversationItem::McpCall::Status) (defaults to: nil) —

    The status of the tool call. One of ‘in_progress`, `completed`, `incomplete`, `c

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

    The type of the item. Always ‘mcp_call`.




# File 'lib/openai/models/conversations/conversation_item.rb', line 564

Instance Attribute Details

#approval_request_id ⇒ String?

Unique identifier for the MCP tool call approval request. Include this value in a subsequent ‘mcp_approval_response` input to approve or reject the corresponding tool call.

Returns:

  • (String, nil) 


543
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 543

optional :approval_request_id, String, nil?: true

#arguments ⇒ String

A JSON string of the arguments passed to the tool.

Returns:

  • (String) 


517
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 517

required :arguments, String

#error ⇒ String?

The error from the tool call, if any.

Returns:

  • (String, nil) 


549
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 549

optional :error, String, nil?: true

#id ⇒ String

The unique ID of the tool call.

Returns:

  • (String) 


511
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 511

required :id, String

#name ⇒ String

The name of the tool that was run.

Returns:

  • (String) 


523
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 523

required :name, String

#output ⇒ String?

The output from the tool call.

Returns:

  • (String, nil) 


555
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 555

optional :output, String, nil?: true

#server_label ⇒ String

The label of the MCP server running the tool.

Returns:

  • (String) 


529
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 529

required :server_label, String

#status ⇒ Symbol, ...

The status of the tool call. One of ‘in_progress`, `completed`, `incomplete`, `calling`, or `failed`.

Returns:



562
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 562

optional :status, enum: -> { OpenAI::Conversations::ConversationItem::McpCall::Status }

#type ⇒ Symbol, :mcp_call

The type of the item. Always ‘mcp_call`.

Returns:

  • (Symbol, :mcp_call) 


535
 
# File 'lib/openai/models/conversations/conversation_item.rb', line 535

required :type, const: :mcp_call