Class: Vapi::McpToolMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/mcp_tool_metadata.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(protocol: OMIT, additional_properties: nil) ⇒ Vapi::McpToolMetadata

Parameters:

  • protocol (Vapi::McpToolMetadataProtocol) (defaults to: OMIT) —

    This is the protocol used for MCP communication. Defaults to Streamable HTTP.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



22
23
24
25
26
27
28
 
# File 'lib/vapi_server_sdk/types/mcp_tool_metadata.rb', line 22

def initialize(protocol: OMIT, additional_properties: nil)
  @protocol = protocol if protocol != OMIT
  @additional_properties = additional_properties
  @_field_set = { "protocol": protocol }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



12
13
14
 
# File 'lib/vapi_server_sdk/types/mcp_tool_metadata.rb', line 12

def additional_properties
  @additional_properties
end

#protocol ⇒ Vapi::McpToolMetadataProtocol (readonly)

Returns This is the protocol used for MCP communication. Defaults to Streamable HTTP.

Returns:



10
11
12
 
# File 'lib/vapi_server_sdk/types/mcp_tool_metadata.rb', line 10

def protocol
  @protocol
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::McpToolMetadata

Deserialize a JSON object to an instance of McpToolMetadata

Parameters:

  • json_object (String)

Returns:



34
35
36
37
38
39
 
# File 'lib/vapi_server_sdk/types/mcp_tool_metadata.rb', line 34

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  protocol = parsed_json["protocol"]
  new(protocol: protocol, additional_properties: struct)
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


54
55
56
 
# File 'lib/vapi_server_sdk/types/mcp_tool_metadata.rb', line 54

def self.validate_raw(obj:)
  obj.protocol&.is_a?(Vapi::McpToolMetadataProtocol) != false || raise("Passed value for field obj.protocol is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of McpToolMetadata to a JSON object

Returns:

  • (String) 


44
45
46
 
# File 'lib/vapi_server_sdk/types/mcp_tool_metadata.rb', line 44

def to_json(*_args)
  @_field_set&.to_json
end