Skip to content

Connectors ​

How connectors give agents access to an external system such as GitHub, a database or a mail server, through a signed connector package, one organisation account and a managed tool.

Enterprise module

Connectors is the enterprise connectors module. A workspace without an Enterprise licence gets 402 from the connectors API. The module also needs the Tools service: with Tools switched off, Connectors is unavailable too.

How it fits together ​

Four things stack on each other:

LevelWhat it is
PackageA signed connector package that defines one kind of connection: GitHub, PostgreSQL, SMTP and so on. It lists the settings, the sign-in methods and the actions. Packages are installed on the Console, not per project.
ConnectorA package installed in one project, with that project's settings (a server address, a repository filter, Read only).
AccountThe one organisation account the connector acts as. Every agent that uses the connector acts as this account.
ToolsThe package's actions, turned into one managed tool in Tools. You bind it to an agent like any other tool.

A connector has exactly one account. To use a second account of the same system, create a second connector.

Use a service account

The account is an organisation account, not a personal one per user. Sign in with a service account or a dedicated token, not with your own login. A connector has no per-user accounts.

Connectors, custom tools and MCP servers ​

ConnectorCustom tool or MCP server
Defined byA signed package from the catalogAn OpenAPI or Postman document, or an MCP URL you give
Sign-inPer-package methods, tested before they are keptA credential you attach to the tool
ActionsFixed by the package and marked read, write or destructiveImported from the document or listed by the server
Updated byA new package versionYou

Use a connector when a package for the system exists. Use custom tools and MCP servers for anything else. Some packages are themselves an MCP server (GitHub MCP); see Connector tools and approvals.

Scope ​

Connectors belong to the active project. Reading is open to everyone with access to Connectors in the project, creating needs write access, and connecting an account, changing settings and deleting need an admin of the project. OAuth apps are the exception: they belong to the workspace and only tenant owners and admins manage them.

Where it lives in the dashboard ​

Open Build → Connectors. The sub-menu has three pages:

PageWhat it shows
CatalogThe connector types installed on this Console, as cards with search and a category filter. Each card has Install, which opens the create form for that type. See Install connector packages.
InstalledThe project's connectors, with Connector, Type, Status, Account, Tools and Updated. Add connector starts a new one.
OAuth appsThe OAuth apps of the workspace, for tenant owners and admins. See Create a connector and connect an account.

Opening a connector shows its page with these tabs:

TabWhat it does
OverviewDetails, the account, the managed tool, and the agents and other resources that use the tool.
AccountThe organisation account: sign-in method, who connected it, access granted, last check, Test connection, Reconnect, Disconnect.
ToolsThe managed tool and the actions of the connector with their access marking. Sync tools.
KnowledgeSources that read the system's data into a Knowledge Engine module on a schedule. Shown for packages that offer a source.
SettingsThe package's settings, and Enable connector or Disable connector.

The packages ​

PackageFamilySign-in methodsWrite or destructive actions
PostgreSQLDatabaseDatabase user and passwordNo. Every statement runs read-only.
MySQLDatabaseDatabase user and passwordNo. Every statement runs read-only.
MariaDBDatabaseDatabase user and passwordNo. Every statement runs read-only.
Amazon S3Object storageAccess key; temporary credentials; public bucket (no credentials)Write: creates new text objects when Read only is off. Never deletes.
MinIO and S3-compatible storageObject storageAccess key; public bucket (no credentials)Write: creates new text objects when Read only is off. Never deletes.
Azure Blob StorageObject storageMicrosoft Entra ID (service principal); SAS token; storage account key; public container (no credentials)Write: creates new text blobs when Read only is off. Never deletes.
Email (SMTP)EmailUser name and password; relay without sign-in (on-prem only)Write: send_email. draft_email is read and sends nothing.
GitHubDeveloper toolsSign in with GitHub (OAuth); sign in with your organization's OAuth app; personal access tokenWrite, and destructive (merge_pull_request), when Read only is off.
GitHub MCPMCPSign in with GitHub (OAuth); sign in with your organization's OAuth app; personal access tokenThe MCP server's tools, marked by the package. Write and destructive tools are hidden while Read only is on.
BitbucketDeveloper toolsEmail and API token; access token; Bitbucket sign-in, read only or read and write (OAuth); HTTP access tokenWrite, when Read only is off.
GrafanaDeveloper toolsService account tokenWrite, and destructive (create_silence), when Read only is off.
JiraWork managementEmail and API token; Atlassian sign-in, read only or read and write (OAuth); personal access tokenWrite, when Read only is off.
AsanaWork managementPersonal access token; Asana sign-in, read only or read and write (OAuth)Write, when Read only is off.
monday.comWork managementPersonal API token; monday sign-in, read only or read and write (OAuth)Write, when Read only is off.
TrelloWork managementAPI key and token; Trello sign-in, read only or read and write (OAuth 2.0)Write, when Read only is off.
CalendlySchedulingPersonal access token; Calendly sign-in, read only or read and write (OAuth)Write, and destructive (cancel_scheduled_event), when Read only is off.
ConfluenceDocs and wikiAPI token (email and token); OAuth 2.0 read only or read and write (your own Atlassian app); personal access tokenWrite, when Read only is off.
NotionDocs and wikiIntegration secret; Notion sign-in (OAuth, your own public integration)Write, when Read only is off.
MediaWikiDocs and wikiPublic access (no sign-in); access token (private wiki)No.
AccuWeatherData and APIsAPI keyNo.
WeatherAPI.comData and APIsAPI keyNo.
PexelsData and APIsAPI keyNo.
YouTubeData and APIsAPI key (public data); Google sign-in, read only or with captions (OAuth)No.
Earthquakes (AFAD, Kandilli)Data and APIsPublic access (no sign-in)No.

"Read only" is a setting of the connector. It is on by default, and the write actions of the package are off while it is on. Several OAuth packages also offer a read-only and a read-and-write sign-in; after you turn Read only off, connect again with the read-and-write method so the sign-in is granted the write permission.

Packages that can also fill a knowledge base from the system (a Knowledge tab): PostgreSQL, MySQL, MariaDB, Amazon S3, MinIO, Azure Blob Storage, GitHub, Bitbucket, Confluence and MediaWiki.

The Catalog shows the packages that are installed on your Console. A Console can have more, fewer or newer packages than this table; the Catalog is the source of truth.

Where to next ​

Studio · Pulse · Console · Agent SDK and more — the Cognipeer documentation hub