Platform API ClientClient group14 methodsMcpServersMethods

mcpServers

Reference methods for mcpServers.

Mcp Servers

mcpServers.create()

Generated exampleHTTP endpoint wrapperPOST /api/v1/mcp-servers

POST /api/v1/mcp-servers

Signature

create(input: CreateMcpServerInput): Promise<McpServerRecord>

Parameters

Name	Type	Flags
input	CreateMcpServerInput	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # CreateMcpServerInput

response = platform.mcpServers.create(input)
print(response)

Response

// Response type
Promise<McpServerRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/mcp-servers

GET /api/v1/mcp-servers

Signature

list(params?: ListMcpServersParams): Promise<ListMcpServersResponse>

Parameters

Name	Type	Flags
params	ListMcpServersParams	optional

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

params = {}  # ListMcpServersParams

response = platform.mcpServers.list(params)
print(response)

Response

// Response type
Promise<ListMcpServersResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.get()

Generated exampleHTTP endpoint wrapperGET /api/v1/mcp-servers/{serverId}

GET /api/v1/mcp-servers/{serverId}

Signature

get(serverId: string): Promise<McpServerRecord>

Parameters

Name	Type	Flags
serverId	string	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"

response = platform.mcpServers.get(serverId)
print(response)

Response

// Response type
Promise<McpServerRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.update()

Generated exampleHTTP endpoint wrapperPUT /api/v1/mcp-servers/{serverId}

PUT /api/v1/mcp-servers/{serverId}

Signature

update(serverId: string, input: UpdateMcpServerInput): Promise<McpServerRecord>

Parameters

Name	Type	Flags
serverId	string	required
input	UpdateMcpServerInput	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"
input = {}  # UpdateMcpServerInput

response = platform.mcpServers.update(serverId, input)
print(response)

Response

// Response type
Promise<McpServerRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.archive()

Generated exampleHTTP endpoint wrapperDELETE /api/v1/mcp-servers/{serverId}

DELETE /api/v1/mcp-servers/{serverId}

Signature

archive(serverId: string): Promise<McpServerRecord>

Parameters

Name	Type	Flags
serverId	string	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"

response = platform.mcpServers.archive(serverId)
print(response)

Response

// Response type
Promise<McpServerRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.createTool()

Generated exampleHTTP endpoint wrapperPOST /api/v1/mcp-servers/{serverId}/tools

POST /api/v1/mcp-servers/{serverId}/tools

Signature

createTool(serverId: string, input: CreateMcpServerToolInput): Promise<McpServerToolRecord>

Parameters

Name	Type	Flags
serverId	string	required
input	CreateMcpServerToolInput	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"
input = {}  # CreateMcpServerToolInput

response = platform.mcpServers.createTool(serverId, input)
print(response)

Response

// Response type
Promise<McpServerToolRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.listTools()

Generated exampleHTTP endpoint wrapperGET /api/v1/mcp-servers/{serverId}/tools

GET /api/v1/mcp-servers/{serverId}/tools

Signature

listTools(serverId: string, params?: { status?: McpToolStatus; capability?: McpToolCapability }): Promise<{ data: McpServerToolRecord[] }>

Parameters

Name	Type	Flags
serverId	string	required
params	{ status?: McpToolStatus; capability?: McpToolCapability }	optional

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"
params = {}  # { status?: McpToolStatus; capability?: McpToolCapability }

response = platform.mcpServers.listTools(serverId, params)
print(response)

Response

// Response type
Promise<{ data: McpServerToolRecord[] }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.updateTool()

Generated exampleHTTP endpoint wrapperPUT /api/v1/mcp-servers/{serverId}/tools/{toolName}

PUT /api/v1/mcp-servers/{serverId}/tools/{toolName}

Signature

updateTool(serverId: string, toolName: string, input: UpdateMcpServerToolInput): Promise<McpServerToolRecord>

Parameters

Name	Type	Flags
serverId	string	required
toolName	string	required
input	UpdateMcpServerToolInput	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"
toolName = {}  # string
input = {}  # UpdateMcpServerToolInput

response = platform.mcpServers.updateTool(serverId, toolName, input)
print(response)

Response

// Response type
Promise<McpServerToolRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.refreshTools()

Generated exampleHTTP endpoint wrapperPOST /api/v1/mcp-servers/{serverId}/refresh-tools

POST /api/v1/mcp-servers/{serverId}/refresh-tools

Signature

refreshTools(serverId: string): Promise<ToolRefreshResult>

Parameters

Name	Type	Flags
serverId	string	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"

response = platform.mcpServers.refreshTools(serverId)
print(response)

Response

// Response type
Promise<ToolRefreshResult>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.healthCheck()

Generated exampleHTTP endpoint wrapperPOST /api/v1/mcp-servers/{serverId}/health-check

POST /api/v1/mcp-servers/{serverId}/health-check

Signature

healthCheck(serverId: string): Promise<HealthCheckResult>

Parameters

Name	Type	Flags
serverId	string	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"

response = platform.mcpServers.healthCheck(serverId)
print(response)

Response

// Response type
Promise<HealthCheckResult>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.healthHistory()

Generated exampleHTTP endpoint wrapperGET /api/v1/mcp-servers/{serverId}/health

GET /api/v1/mcp-servers/{serverId}/health

Signature

healthHistory(serverId: string, params?: { cursor?: string; limit?: number }): Promise<{ data: McpServerHealthLogRecord[]; nextCursor: string | null }>

Parameters

Name	Type	Flags
serverId	string	required
params	{ cursor?: string; limit?: number }	optional

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"
params = {}  # { cursor?: string; limit?: number }

response = platform.mcpServers.healthHistory(serverId, params)
print(response)

Response

// Response type
Promise<{ data: McpServerHealthLogRecord[]; nextCursor: string | null }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.linkSystem()

Generated exampleHTTP endpoint wrapperPOST /api/v1/mcp-servers/{serverId}/link

POST /api/v1/mcp-servers/{serverId}/link

Signature

linkSystem(serverId: string, input: { systemId: string; tools?: string[] }): Promise<McpServerUsageRecord>

Parameters

Name	Type	Flags
serverId	string	required
input	{ systemId: string; tools?: string[] }	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"
input = {}  # { systemId: string; tools?: string[] }

response = platform.mcpServers.linkSystem(serverId, input)
print(response)

Response

// Response type
Promise<McpServerUsageRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.unlinkSystem()

Generated exampleHTTP endpoint wrapperDELETE /api/v1/mcp-servers/{serverId}/link/{systemId}

DELETE /api/v1/mcp-servers/{serverId}/link/{systemId}

Signature

unlinkSystem(serverId: string, systemId: string): Promise<{ success: boolean }>

Parameters

Name	Type	Flags
serverId	string	required
systemId	string	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"
systemId = "<systemId>"

response = platform.mcpServers.unlinkSystem(serverId, systemId)
print(response)

Response

// Response type
Promise<{ success: boolean }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

mcpServers.linkedSystems()

Generated exampleHTTP endpoint wrapperGET /api/v1/mcp-servers/{serverId}/systems

GET /api/v1/mcp-servers/{serverId}/systems

Signature

linkedSystems(serverId: string): Promise<{ data: LinkedSystemRecord[] }>

Parameters

Name	Type	Flags
serverId	string	required

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

serverId = "<serverId>"

response = platform.mcpServers.linkedSystems(serverId)
print(response)

Response

// Response type
Promise<{ data: LinkedSystemRecord[] }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));