Class: Telnyx::Resources::AI::McpServers

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/ai/mcp_servers.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ McpServers

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of McpServers.

Parameters:



127
128
129
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 127

def initialize(client:)
  @client = client
end

Instance Method Details

#create(name:, type:, url:, allowed_tools: nil, api_key_ref: nil, request_options: {}) ⇒ Telnyx::Models::AI::McpServerCreateResponse

Create a new MCP server.

Parameters:

  • name (String)
  • type (String)
  • url (String)
  • allowed_tools (Array<String>, nil)
  • api_key_ref (String, nil)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 21

def create(params)
  parsed, options = Telnyx::AI::McpServerCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "ai/mcp_servers",
    body: parsed,
    model: Telnyx::Models::AI::McpServerCreateResponse,
    options: options
  )
end

#delete(mcp_server_id, request_options: {}) ⇒ nil

Delete a specific MCP server.

Parameters:

Returns:

  • (nil)

See Also:



115
116
117
118
119
120
121
122
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 115

def delete(mcp_server_id, params = {})
  @client.request(
    method: :delete,
    path: ["ai/mcp_servers/%1$s", mcp_server_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(page_number: nil, page_size: nil, type: nil, url: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPaginationTopLevelArray<Telnyx::Models::AI::McpServerListResponse>

Retrieve a list of MCP servers.

Parameters:

  • page_number (Integer)
  • page_size (Integer)
  • type (String)
  • url (String)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 92

def list(params = {})
  parsed, options = Telnyx::AI::McpServerListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "ai/mcp_servers",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPaginationTopLevelArray,
    model: Telnyx::Models::AI::McpServerListResponse,
    options: options
  )
end

#retrieve(mcp_server_id, request_options: {}) ⇒ Telnyx::Models::AI::McpServerRetrieveResponse

Retrieve details for a specific MCP server.

Parameters:

Returns:

See Also:



42
43
44
45
46
47
48
49
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 42

def retrieve(mcp_server_id, params = {})
  @client.request(
    method: :get,
    path: ["ai/mcp_servers/%1$s", mcp_server_id],
    model: Telnyx::Models::AI::McpServerRetrieveResponse,
    options: params[:request_options]
  )
end

#update(mcp_server_id, id: nil, allowed_tools: nil, api_key_ref: nil, created_at: nil, name: nil, type: nil, url: nil, request_options: {}) ⇒ Telnyx::Models::AI::McpServerUpdateResponse

Update an existing MCP server.

Parameters:

  • mcp_server_id (String)
  • id (String)
  • allowed_tools (Array<String>, nil)
  • api_key_ref (String, nil)
  • created_at (Time)
  • name (String)
  • type (String)
  • url (String)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 68

def update(mcp_server_id, params = {})
  parsed, options = Telnyx::AI::McpServerUpdateParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["ai/mcp_servers/%1$s", mcp_server_id],
    body: parsed,
    model: Telnyx::Models::AI::McpServerUpdateResponse,
    options: options
  )
end