open-connector README

The project's README from github.com/oomol-lab/open-connector. As one markdown file: README.md.

OpenConnector - Connect Once. Use Everywhere.

English | 简体中文 | 繁體中文 | 日本語 | 한국어 | Русский | Français | Español

License: Apache-2.0 Node.js 22+ Cloudflare compatible MCP OpenAPI

Providers Actions

OpenConnector is an open-source connector gateway for AI agents and an alternative to Pipedream/Composio. Connect user app accounts once, then expose a shared catalog of 1,000+ providers and 10,000+ prebuilt Actions to agents and applications.

OOMOL Self-hosted More platforms
Managed OAuth and hosted runtime, ready to use. No deployment or OAuth app setup. Run locally or on your own infrastructure with Docker or Node.js. You manage storage and OAuth apps. Cloudflare, Fly.io, RepoCloud, nibrun, and more.
🚀 OOMOL Hosted Self-host More platforms

Use the Connector SDK from app code, oo CLI as the local-agent relay, MCP from agent hosts, HTTP/OpenAPI from custom clients, and the Web Console for administration and debugging.

What It Provides

Where It Fits

OpenConnector fits products where agents need durable access to the tools users already use, without handing provider credentials to the agent process.

Developer Tools

Tool Purpose
Connector SDK Thin TypeScript HTTP client. Use OpenConnector for self-hosted runtimes, or Connector / ProjectConnector for OOMOL-hosted personal and SaaS end-user connections.
oo CLI Local agent relay for connector Actions. oo connector can search, inspect, and run Actions against OOMOL-hosted or self-hosted OpenConnector runtimes.
MCP Expose app Actions to MCP-capable agent hosts through http://localhost:3000/mcp.
HTTP / OpenAPI Call /v1/actions/* directly or inspect the generated /openapi.json document.

Endpoint details, response envelopes, auth headers, MCP tools, and Action guide examples are in docs/runtime-api.md.

Dashboard Preview

OpenConnector ships with a local Dashboard for browsing connectors, configuring credentials, creating runtime tokens, and inspecting runtime usage.

Connector Catalog

Use the connector catalog to see available services, search for providers, and open their Actions and credential setup from one place.

OpenConnector connector catalog dashboard

Usage Overview

Use the Overview page after deployment to monitor runtime readiness, available providers, executable Actions, recent failures, tool call trends, and recent calls.

OpenConnector runtime overview dashboard

Provider names and trademarks belong to their respective owners and are used only for identification and interoperability.

How It Works

flowchart LR
  Agent["AI Agent / App"] -->|"SDK / CLI / MCP / HTTP"| Gateway["OpenConnector Gateway"]
  Gateway --> Auth["Credential & OAuth Boundary"]
  Gateway --> Catalog["Provider Catalog"]
  Gateway --> Actions["Open-source Action Executors"]
  Gateway --> Policy["Tokens, Scopes, Allow/Block Policy"]
  Gateway --> Logs["Run Logs"]
  Actions --> Providers["1,000+ Providers"]
  Console["Web Console"] --> Gateway
  Cloudflare["Cloudflare Workers, D1, R2"] -. deploy .-> Gateway

Apps and agents discover Actions, inspect schemas and scopes, select a connection alias, and execute through the gateway. Provider secrets stay behind the runtime boundary; agents receive the metadata, safe account labels, and execution results needed for the run.

Usage Paths

Path Best for Includes
Open-source self-host Developers and teams that want full control Local Docker or Node runtime, SQLite or PostgreSQL state, local or S3-compatible transit files, MCP, HTTP, OpenAPI, and Web Console
Kubernetes (Helm) Teams that run their own clusters Hardened Helm chart with PVC-backed SQLite or PostgreSQL plus migration hooks, Ingress, autoscaling, and NetworkPolicy toggles
OOMOL Teams that want users to authorize accounts immediately OOMOL-provided OAuth apps, monthly included Connect credits, and hosted runtime infrastructure; the same provider and Action contracts keep a path open to later private or self-hosted deployment

Quick Start

[!NOTE] This starts a self-hosted runtime. OAuth providers require OAuth client credentials from apps you register with those providers. To let users authorize supported providers without setting up your own OAuth apps, use OOMOL-hosted connectors.

Start the runtime from the published image with Docker Compose:

docker compose up

This pulls ghcr.io/oomol-lab/open-connector:latest. To build from source instead:

docker compose -f docker-compose.yml -f docker-compose.build.yml up --build

Open the local console and generated API reference:

http://localhost:3000
http://localhost:3000/docs

Run a no-auth Action to verify the runtime:

curl -s -X POST http://localhost:3000/v1/actions/hackernews.get_top_stories \
  -H 'content-type: application/json' \
  -d '{"input":{}}'

See docs/quickstart.md for the full local setup, first provider connection, OAuth flow, and runtime settings.

Connect a Provider

GitHub is the simplest credentialed example because it can use a personal access token:

curl -s -X PUT http://localhost:3000/api/connections/github \
  -H 'content-type: application/json' \
  -d '{"authType":"api_key","values":{"apiKey":"github_pat_..."}}'

curl -s -X POST http://localhost:3000/v1/actions/github.get_current_user \
  -H 'content-type: application/json' \
  -d '{"input":{}}'

For OAuth2 apps, named connections, credential encryption, token refresh, and action policies, see docs/credentials.md and docs/configuration.md.

Web Console

For npm-based local development, open http://localhost:5173; the Web Console dev server proxies API requests to the runtime on http://localhost:3000. For Docker or a built Node runtime, the console is served from http://localhost:3000.

The console supports provider browsing, API key and OAuth client configuration, runtime token creation, Action schema inspection, Action debugging, recent run review, and access to the generated OpenAPI and MCP metadata.

PostgreSQL Runtime Storage

The Node runtime uses SQLite by default and can use PostgreSQL 15 or newer when OOMOL_CONNECT_DATABASE_URL is configured. PostgreSQL migrations are explicit: run npm run runtime:migrate before starting a version with pending migrations. Server startup only checks schema readiness and never applies PostgreSQL DDL. See docs/configuration.md for configuration, permissions, TLS, and multi-instance requirements. The Docker image exposes the same runner as its migrate subcommand; see docs/docker-ghcr.md.

Docker Image (GHCR)

Run OpenConnector from a prebuilt image on GitHub Packages (GHCR): ghcr.io/oomol-lab/open-connector. Use latest for the newest release, a pinned released version for production, or tip for the latest main build.

See docs/docker-ghcr.md for tags, pulling, and running.

Build a Desktop Agent with Wanta

OpenConnector and Wanta are two open-source projects for AI Agents in the OOMOL ecosystem. OpenConnector connects Agents to external services such as Gmail, Slack, and Notion. Wanta provides a complete desktop Agent application powered by OpenCode and uses OpenConnector to work with connected SaaS services.

Issues and pull requests are welcome.

Documentation

Development

Use Node.js 22 or newer:

npm install
npm run dev

The local API runtime listens on http://localhost:3000. The Web Console dev server listens on http://localhost:5173 and proxies API requests to the runtime.

Before opening a pull request:

npm run fix-check
npm test

Provider code lives under src/providers/<service>. See CONTRIBUTING.md for provider contribution rules.

License Scope

Unless otherwise noted, the source code, scripts, generated project scaffolding, tests, and documentation authored for this repository are licensed under the Apache License, Version 2.0. See LICENSE.txt.

The Apache-2.0 license for this repository does not grant rights to third-party products, providers, apps, APIs, trademarks, service marks, trade names, logos, icons, brand assets, documentation, screenshots, or other copyrighted materials owned by their respective holders.

Provider and app names, metadata, links, scopes, permissions, and optional logos/icons are included only to identify services and enable interoperability. All third-party brand and product rights remain with their respective owners. Inclusion in this catalog does not imply endorsement, sponsorship, partnership, certification, or verification by those owners.

If you contribute provider metadata or assets, only submit material you have the right to submit. Prefer linking to official public assets instead of copying brand files into this repository.

Community

Please keep issues and pull requests focused, respectful, and actionable. Participation in this project is governed by CODE_OF_CONDUCT.md.

Support OpenConnector

If OpenConnector is useful to you, giving it a ⭐ helps more developers discover the project.

How to star OpenConnector on GitHub

Contributors

Thanks to everyone who has helped build OpenConnector. Want to join them? See CONTRIBUTING.md.

OpenConnector contributors

Star History

Star history

open-connector (oomol-lab/open-connector)

cloudflare-workers
Searching Database…

6K ·GitHub
Open-connector
What is this?OpenConnector is an open-source connector gateway that lets AI agents authenticate to and call 1,000+ SaaS providers (GitHub, Gmail, Notion, Slack, BigQuery, etc.) through a shared catalog of prebuilt Actions, acting as an open alternative to Pipedream or Composio.
Is this a gateway I run myself, or a hosted service I just call?Both: you can self-host it locally or on your own infrastructure with Docker or Node.js and manage your own storage and OAuth apps, or use OOMOL's hosted runtime with managed OAuth, with the same provider and Action contracts in either mode.
How do I get it running?Start the self-hosted runtime via Docker Compose, which pulls the ghcr.io/oomol-lab/open-connector image, or build from source; then open the local Web Console and generated API reference to configure it.
What do I need before connecting an OAuth provider?You need OAuth client credentials from an app you register with each provider yourself, unless you use OOMOL-hosted connectors, which supply ready-made OAuth apps; GitHub is the simplest case since it can authenticate with just a personal access token.
Any install pitfalls when switching to PostgreSQL?PostgreSQL migrations are not automatic: you must run 'npm run runtime:migrate' before starting a version with pending migrations, since server startup only checks schema readiness and never applies the DDL itself.
How do agents and apps actually talk to it?Through whichever interface fits your stack: the TypeScript Connector SDK from app code, the 'oo' CLI as a local agent relay, MCP for MCP-capable agent hosts, or direct HTTP/OpenAPI calls, plus a Web Console for admin and debugging.
Do agents ever see my raw provider credentials?No, provider secrets stay behind the runtime boundary; agents only receive action metadata, safe account labels, and execution results needed for a run.
What does the Apache-2.0 license actually cover here?The Apache-2.0 license covers the repository's source code, scripts, scaffolding, tests and docs, but it does not grant any rights to third-party providers, their trademarks, logos, or brand assets included in the catalog for identification purposes only.
Can I deploy this on Kubernetes?Yes, there is a hardened Helm chart with PVC-backed SQLite or PostgreSQL state, migration hooks, Ingress, autoscaling, and NetworkPolicy toggles for teams running their own clusters.
What is Wanta and how does it relate to OpenConnector?Wanta is a separate open-source desktop AI agent app, powered by OpenCode, that uses OpenConnector under the hood to let its agent work with connected SaaS services like Gmail, Slack, and Notion.
What storage options does the runtime support?The Node runtime uses SQLite by default and can switch to PostgreSQL 15+, with temporary file transit stored either locally or in S3-compatible storage.
Can I try it without setting up OAuth first?Yes, the quickstart includes running a no-auth Action against the local runtime to verify everything works before connecting a real credentialed provider.
What are similar projects?trueforge, executor, anythingmcp, goshen-email, buzzkit, casdoor, open-webui, electric
Which topics is it in?agent-tools, api-gateway, openapi, cloudflare-workers, oauth, model-context-protocol, kubernetes, postgresql, docker-compose, sdk, cloud, database
Creator
oomol-lab
Size
32.8 MB
Stars
6K
Updated
CommitOct 17Releasev1.9.0Oct 15
Age
3mo
Commits · 90 Days