---
title: "Connector"
description: "The `Connector` entity."
section: "Reference"
group: "Types"
order: 48
---

## Definition

```ts
interface Connector {
  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;
}
```

## Fields

| Field          | Type                              | Notes                                                                            |
| -------------- | --------------------------------- | -------------------------------------------------------------------------------- |
| `id`           | `string`                          | `readonly` `required`                                                            |
| `name`         | `string`                          | `required` — Display name (e.g. 'Slack', 'GitHub').                              |
| `slug`         | `string`                          | `required` — URL-safe identifier used in routes and config keys.                 |
| `description`  | `string \| null`                  | `required` — Optional short description shown on the connector card.             |
| `iconUrl`      | `string \| null`                  | `required` — Public URL of the connector's brand icon.                           |
| `mcpUrl`       | `string`                          | `required` — Remote MCP server endpoint this connector wires into.               |
| `oauthScopes`  | `string \| null`                  | `required` — Space-separated OAuth scopes requested during auth, if any.         |
| `configSchema` | `Record<string, unknown> \| null` | `required` — JSON schema describing the config needed to install this connector. |
| `enabled`      | `boolean`                         | `required` — Whether the connector is available for workspaces to install.       |
| `createdAt`    | `string`                          | `readonly` `required` — ISO-8601 timestamp of creation.                          |