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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const input = {} as CreateMcpServerInput;
// Fill the input payload fields before calling this method.

const response = await client.mcpServers.create(input);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const params = {} as ListMcpServersParams;
// Fill the params payload fields before calling this method.

const response = await client.mcpServers.list(params);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";

const response = await client.mcpServers.get(serverId);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";
const input = {} as UpdateMcpServerInput;

const response = await client.mcpServers.update(serverId, input);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";

const response = await client.mcpServers.archive(serverId);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";
const input = {} as CreateMcpServerToolInput;

const response = await client.mcpServers.createTool(serverId, input);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

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

const response = await client.mcpServers.listTools(serverId, params);
console.log(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/{value}

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

Signature

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

Parameters

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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";
const toolName = {} as string;
const input = {} as UpdateMcpServerToolInput;

const response = await client.mcpServers.updateTool(serverId, toolName, input);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";

const response = await client.mcpServers.refreshTools(serverId);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";

const response = await client.mcpServers.healthCheck(serverId);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

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

const response = await client.mcpServers.healthHistory(serverId, params);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

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

const response = await client.mcpServers.linkSystem(serverId, input);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";
const systemId = "<systemId>";

const response = await client.mcpServers.unlinkSystem(serverId, systemId);
console.log(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

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const serverId = "<serverId>";

const response = await client.mcpServers.linkedSystems(serverId);
console.log(response);

Response

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

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