ConnectorWithStatus

The `ConnectorWithStatus` entity.

Definition

TypeScript

interface ConnectorWithStatus {
  id: string;
  name: string;
  slug: string;
  description: string | null;
  iconUrl: string | null;
  mcpUrl: string;
  oauthScopes: string | null;
  configSchema: Record<string, unknown> | null;
  enabled: boolean;
  createdAt: string;
  server: {
    id: string;
    status: "error" | "connected" | "disconnected" | null;
    config: Record<string, unknown> | null;
  } | null;
}

Fields

Field	Type	Notes
`id`	`string`	`readonly` `required` — MCP server record for this workspace's install of the connector.
`name`	`string`	`required`
`slug`	`string`	`required`
`description`	`string \| null`	`required`
`iconUrl`	`string \| null`	`required`
`mcpUrl`	`string`	`required`
`oauthScopes`	`string \| null`	`required`
`configSchema`	`Record<string, unknown> \| null`	`required`
`enabled`	`boolean`	`required`
`createdAt`	`string`	`readonly` `required`
`server`	`{ id: string; status: "error" \| "connected" \| "disconnected" \| null; config: Record<string, unknown> \| null; } \| null`	`required` — Workspace-specific install info; null when not installed.