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

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

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:



155
156
157
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 155

def initialize(client:)
  @client = client
end

Instance Method Details

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

Some parameter documentations has been truncated, see Models::AI::McpServerCreateParams for more details.

Creates a new MCP server configuration on your account and returns the created server.

Parameters:

  • name (String) —

    Body param

  • type (String) —

    Body param

  • url (String) —

    Body param

  • allowed_tools (Array<String>, nil) —

    Body param

  • api_key_ref (String, nil) —

    Body param

  • idempotency_key (String) —

    Header param: Optional opaque, unquoted key for safely retrying the same logical

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 32

def create(params)
  parsed, options = Telnyx::AI::McpServerCreateParams.dump_request(params)
  header_params = {idempotency_key: "idempotency-key"}
  @client.request(
    method: :post,
    path: "ai/mcp_servers",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Telnyx::AI::McpServer,
    options: options
  )
end

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

Permanently deletes the specified MCP server configuration from your account.

Parameters:

  • mcp_server_id (String) —

    Unique identifier of the mcp server.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



143
144
145
146
147
148
149
150
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 143

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::McpServer>

Returns a paginated list of the MCP servers configured on your account, with optional filtering by type or URL.

Parameters:

  • page_number (Integer) —

    Page number to retrieve (1-based).

  • page_size (Integer) —

    Number of items to return per page.

  • type (String) —

    Filter results by type.

  • url (String) —

    Filter results by url.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 119

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::AI::McpServer,
    options: options
  )
end

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

Retrieve details for a specific MCP server.

Parameters:

  • mcp_server_id (String) —

    Unique identifier of the mcp server.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



56
57
58
59
60
61
62
63
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 56

def retrieve(mcp_server_id, params = {})
  @client.request(
    method: :get,
    path: ["ai/mcp_servers/%1$s", mcp_server_id],
    model: Telnyx::AI::McpServer,
    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::McpServer

Updates the specified MCP server's configuration and returns the updated server.

Parameters:

  • mcp_server_id (String) —

    Unique identifier of the mcp server.

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



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/telnyx/resources/ai/mcp_servers.rb', line 90

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::AI::McpServer,
    options: options
  )
end