McpServer

The `McpServer` entity.

Definition

TypeScript

interface McpServer {
  id: string;
  workspaceId: string;
  name: string;
  url: string;
  authType: "none" | "oauth" | "api_key";
  oauthClientId: string | null;
  oauthTokenEndpoint: string | null;
  oauthAuthorizationEndpoint: string | null;
  oauthScopes: string | null;
  oauthExpiresAt: string | null;
  headers: any;
  connectorId: string | null;
  connectorConfig: any;
  connectorStatus: "error" | "connected" | "disconnected" | null;
  createdBy: string;
  createdAt: string;
  updatedAt: string;
}

Fields

Field	Type	Notes
`id`	`string`	`readonly` `required`
`workspaceId`	`string`	`required` — Workspace that owns this server.
`name`	`string`	`required` — Human-readable server name.
`url`	`string`	`required` — Remote MCP server endpoint URL.
`authType`	`"none" \| "oauth" \| "api_key"`	`required` — Authentication method used when calling the server.
`oauthClientId`	`string \| null`	`required` — OAuth client ID, when authType is 'oauth'.
`oauthTokenEndpoint`	`string \| null`	`required` — OAuth token endpoint URL, when authType is 'oauth'.
`oauthAuthorizationEndpoint`	`string \| null`	`required` — OAuth authorization endpoint URL, when authType is 'oauth'.
`oauthScopes`	`string \| null`	`required` — Space-separated OAuth scopes requested during auth.
`oauthExpiresAt`	`string \| null`	`required` — ISO-8601 timestamp when the current OAuth access token expires.
`headers`	`any`	`required` — Extra HTTP headers sent on every request to the server.
`connectorId`	`string \| null`	`required` — Connector catalog entry this server was installed from, if any.
`connectorConfig`	`any`	`required` — Connector-specific config values for this install.
`connectorStatus`	`"error" \| "connected" \| "disconnected" \| null`	`required` — Current connector lifecycle status (idle, connected, failed, …).
`createdBy`	`string`	`required` — User who registered the server.
`createdAt`	`string`	`readonly` `required` — ISO-8601 timestamp of creation.
`updatedAt`	`string`	`readonly` `required` — ISO-8601 timestamp of the last update.