Class: OpenAI::Models::Responses::ResponseItem::McpCall

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseItem::McpCall

Defined in:

lib/openai/models/responses/response_item.rb

Instance Attribute Summary

• #arguments ⇒ String

  A JSON string of the arguments passed to the tool.

• #error ⇒ String^?

  The error from the tool call, if any.

• #id ⇒ String

  The unique ID of the tool call.

• #name ⇒ String

  The name of the tool that was run.

• #output ⇒ String^?

  The output from the tool call.

• #server_label ⇒ String

  The label of the MCP server running the tool.

• #type ⇒ Symbol, :mcp_call

  The type of the item.

Instance Method Summary

• #initialize(id: , arguments: , name: , server_label: , error: nil, output: nil, type: :mcp_call) ⇒ Object constructor

  Some parameter documentations has been truncated, see McpCall for more details.

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

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

An invocation of a tool on an MCP server.

Parameters:

• id (String) (defaults to: ) —

  The unique ID of the tool call.

• arguments (String) (defaults to: ) —

  A JSON string of the arguments passed to the tool.

• name (String) (defaults to: ) —

  The name of the tool that was run.

• server_label (String) (defaults to: ) —

  The label of the MCP server running the tool.

• 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.

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

  The type of the item. Always ‘mcp_call`.

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

Instance Attribute Details

#arguments ⇒ String

A JSON string of the arguments passed to the tool.

Returns:

• (String)

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

required :arguments, String

#error ⇒ String^?

The error from the tool call, if any.

Returns:

• (String, nil)

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

optional :error, String, nil?: true

#id ⇒ String

The unique ID of the tool call.

Returns:

• (String)

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

required :id, String

#name ⇒ String

The name of the tool that was run.

Returns:

• (String)

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

required :name, String

#output ⇒ String^?

The output from the tool call.

Returns:

• (String, nil)

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

optional :output, String, nil?: true

#server_label ⇒ String

The label of the MCP server running the tool.

Returns:

• (String)

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

required :server_label, String

#type ⇒ Symbol, :mcp_call

The type of the item. Always ‘mcp_call`.

Returns:

• (Symbol, :mcp_call)

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

required :type, const: :mcp_call