Skip to content

QUICKSTART

Run OpenConnector and call your first Action

Choose a local runtime for full control, or OOMOL to skip deployment. Both paths lead to calling real Actions.

Run LocallyUse OOMOL

01 / YOUR INFRASTRUCTURE

Run a local OpenConnector instance.

You need Git and Docker with Docker Compose. Start with a no-auth Action before configuring an app account.

  1. 1. Start the runtime

    Clone the repository and start its published image. Keep this local trial on your own machine.

    Terminal
    git clone https://github.com/oomol-lab/open-connector.git
cd open-connector
docker compose up

  2. 2. Run your first Action

    In another terminal, fetch the top Hacker News stories. This read-only Action does not require a provider account.

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

  3. 3. Connect an account

    Open the local console, select a provider, and configure its credentials. OAuth providers require an OAuth app you register with that service.

    Credentials & OAuth
OpenConnector runtime overview with readiness, Action activity, and recent run logs
Project screenshot from the open-source repository. Catalog counts reflect the captured version.

Before exposing a runtime publicly, configure admin authentication, runtime tokens, credential encryption, and the public OAuth origin. Follow the deployment guide for production settings.

Full Deployment Guide

02 / SKIP DEPLOYMENT

Connect with OOMOL.

Use the hosted runtime and managed OAuth for supported apps. Choose how you want to call your connections.

  1. 01

    Connect your app

    Sign in to OOMOL, choose an app, and authorize the account you want to use. Some apps require an API key or custom credentials.

  2. 02

    Choose your client

    Follow the agent setup for CLI or MCP. For backend code, create a personal API key and use the Connector SDK client.

  3. 03

    Make a first call

    Start with a small read-only Action. Check the selected connection and permissions before running it.

Connect Apps in OOMOLConnect Your AgentUse the Hosted SDK
Read as Markdown