# OOMOL

> OOMOL helps AI agents work with connected Apps, reusable Skills, and hosted connector actions through user-approved tool calls.

OOMOL provides an agent-facing way to call third-party services without placing account passwords, OAuth tokens, or raw credentials into prompts or project files. Users connect accounts in OOMOL, then supported agents and Skills can call approved tools for tasks such as reading context, posting updates, creating records, uploading files, or running connector actions from backend code.

Use this index to fetch Markdown resources that are easier for agents to read than rendered HTML.

## When to use OOMOL

- Use OOMOL when a user asks an AI agent to read or update information in connected Apps, such as finding messages, creating records, or uploading files. Check that the required App and action are available for the user's authorized connection.
- Use reusable Skills when an agent needs instructions for a repeatable task, and Flow when the task needs a persistent workflow.
- Use Connector from trusted backend code for your own connected accounts. Use Connector for SaaS when each product user needs a separate account connection. Use OpenConnector when you need to run the connector gateway in your own environment.

## How to call OOMOL

- [Install the official oo CLI](https://oomol.com/en/docs/agents/cli.md): Follow the platform-specific installation guide, run `oo --version`, then `oo login` and let the user complete sign-in. Discover the available tools before choosing an action.
- [Configure MCP](https://oomol.com/en/docs/agents/mcp.md): Use the authenticated MCP connection when the client supports MCP. Tool availability depends on the user's connections and permissions.
- [Use the Connector SDK](https://oomol.com/en/docs/connector-sdk.md): Choose the client for your account and tenant model, then discover providers and actions before making a call.
- [Read the public app catalog API](https://oomol.com/openapi.json): GET /{lang}/apps/catalog.json lists public catalog information without credentials. It does not execute tools or grant access to connected accounts.

Confirm the user's intended account and action before accessing connected data. Follow the user's authorization for writes and sharing, and keep passwords, API keys, and OAuth tokens out of prompts and public files.

## Installation Guides

Use these guides to install oo CLI for a specific agent, sign in from a terminal, or connect OOMOL tools to an MCP client.

- [Install OOMOL for Any AI Agent](https://oomol.com/en/install/agent.md): Install oo CLI and sign in from any AI agent.
- [Install OOMOL for Codex](https://oomol.com/en/install/codex.md): Install oo CLI and sign in when setting up OOMOL in Codex.
- [Install OOMOL for ChatGPT](https://oomol.com/en/install/chatgpt.md): Install oo CLI and sign in when setting up OOMOL in ChatGPT.
- [Install OOMOL for Claude Code](https://oomol.com/en/install/claude-code.md): Install oo CLI and sign in when setting up OOMOL in Claude Code.
- [Install OOMOL for Cursor](https://oomol.com/en/install/cursor.md): Install oo CLI and sign in when setting up OOMOL in Cursor.
- [Install OOMOL for Gemini CLI](https://oomol.com/en/install/gemini-cli.md): Install oo CLI and sign in when setting up OOMOL in Gemini CLI.
- [Install OOMOL for Hermes](https://oomol.com/en/install/hermes.md): Install oo CLI and sign in when setting up OOMOL in Hermes.
- [Install OOMOL for OpenClaw](https://oomol.com/en/install/openclaw.md): Install oo CLI and sign in when setting up OOMOL in OpenClaw.
- [Install OOMOL for CodeBuddy](https://oomol.com/en/install/codebuddy.md): Install oo CLI and sign in when setting up OOMOL in CodeBuddy.
- [Install OOMOL for WorkBuddy](https://oomol.com/en/install/workbuddy.md): Install oo CLI and sign in when setting up OOMOL in WorkBuddy.
- [Install OOMOL for Qoder](https://oomol.com/en/install/qoder.md): Install oo CLI and sign in when setting up OOMOL in Qoder.
- [Install oo CLI](https://oomol.com/en/install/cli.md): Install oo CLI on macOS, Linux, or Windows, then sign in.
- [Configure OOMOL MCP](https://oomol.com/en/install/mcp.md): Connect OOMOL tools to an HTTP MCP client.

## Product & Catalogs

- [API guide](https://oomol.com/api/llms.txt): Public catalog usage, conditional requests, errors, and connected-account integration guides.
- [Agentic resource directory](https://oomol.com/.well-known/ard.json): Machine-readable descriptions of published OOMOL resources.
- [Public website OpenAPI specification](https://oomol.com/openapi.json): Read-only app catalog API. No authentication or OAuth scopes are required; connected-account APIs are hosted separately.
- [OpenConnector by OOMOL](https://openconnector.io/en/index.md): Official project overview of OOMOL’s open-source connector gateway. Deployment and SDK guides are listed below.
- [Product overview](https://oomol.com/en/overview.md): OOMOL, Skills, hosted integrations, and OpenConnector.
- [Guides and document tools](https://oomol.com/en/resources/): Integration guides, PDF Craft, and EPUB Translator.
- [Pricing](https://oomol.com/en/pricing.md): Plans, included usage, and current service rates from the same sources as the pricing page.
- [Apps](https://oomol.com/en/apps/catalog.md): Supported Apps, authentication methods, and featured actions.
- [Skills](https://oomol.com/en/skills/): Browse reusable Skills and follow the next-page links to explore more.

## Languages

- [en documentation](https://oomol.com/en/docs/llms.txt): Markdown documentation in en.
- [zh-cn documentation](https://oomol.com/zh-cn/docs/llms.txt): Markdown documentation in zh-cn.
- [zh-tw documentation](https://oomol.com/zh-tw/docs/llms.txt): Markdown documentation in zh-tw.
- [ja documentation](https://oomol.com/ja/docs/llms.txt): Markdown documentation in ja.
- [ko documentation](https://oomol.com/ko/docs/llms.txt): Markdown documentation in ko.
- [ru documentation](https://oomol.com/ru/docs/llms.txt): Markdown documentation in ru.
- [fr documentation](https://oomol.com/fr/docs/llms.txt): Markdown documentation in fr.
- [es documentation](https://oomol.com/es/docs/llms.txt): Markdown documentation in es.

## Flow Automation

Build the same workflow with an AI agent and Workbench; choose OOMOL Hosted or self-hosted Open Flow.

- [Get Started with Flow](https://oomol.com/en/docs/flow.md): Choose OOMOL Flow or self-hosted Open Flow, create a Draft with an AI agent, inspect it in Workbench, and publish when ready.

## Getting Started

Use these guides to understand OOMOL, choose the correct Agent or Connector path, complete a first tool call, and learn the shared object model.

- [Introduction to OOMOL](https://oomol.com/en/docs/introduction.md): Understand how OOMOL connects Apps, Agents, Skills, and product backends without exposing account credentials to prompts or application code.
- [Choose an integration path](https://oomol.com/en/docs/choose-a-path.md): Choose between Agent setup, the hosted Connector SDK, a Connector SaaS project, and self-hosted OpenConnector.
- [Core concepts](https://oomol.com/en/docs/core-concepts.md): Distinguish the concepts shared by the three Connector products and the identity, permission, and runtime model each product uses.

## Agents & CLI

Use these guides to connect an App, configure OOMOL for an AI Agent, and complete approved tool calls through oo CLI or MCP.

- [Quickstart](https://oomol.com/en/docs/agents.md): Understand the difference between oo CLI and MCP, then choose the installation for your Agent in OOMOL Console.
- [Use OOMOL with any AI Agent](https://oomol.com/en/docs/agents/any-agent.md): Install oo CLI from an AI Agent with terminal access, sign in, and verify the OOMOL tools available to it.
- [Use OOMOL in Codex](https://oomol.com/en/docs/agents/codex.md): Ask Codex to install oo CLI, sign in to OOMOL, and verify access to connected App tools.
- [Use OOMOL in ChatGPT](https://oomol.com/en/docs/agents/chatgpt.md): Connect ChatGPT to OOMOL through oo CLI in a terminal-enabled environment or through OOMOL MCP.
- [Use OOMOL in Claude Code](https://oomol.com/en/docs/agents/claude-code.md): Ask Claude Code to install oo CLI, sign in to OOMOL, and verify connected App tools.
- [Install oo CLI](https://oomol.com/en/docs/agents/cli.md): Install oo CLI on macOS, Linux, or Windows, sign in to OOMOL, and verify the command.
- [Configure OOMOL MCP](https://oomol.com/en/docs/agents/mcp.md): Connect OOMOL tools to an AI client that supports remote HTTP MCP servers.

## Connector

Use these guides when trusted backend code needs to call Apps connected to your own OOMOL account through the hosted Connector gateway.

- [Connector overview](https://oomol.com/en/docs/connector.md): Call Apps connected to your OOMOL account from trusted backend code with the hosted Connector gateway.
- [Call connected Apps with the SDK](https://oomol.com/en/docs/connector-client.md): Use the hosted Connector client to call Apps connected to your OOMOL account from trusted TypeScript backend code.

## For SaaS Products

Use these guides to let each product user connect an account and execute Connector actions for that user from a trusted backend.

- [SaaS integration overview](https://oomol.com/en/docs/saas.md): Let each user of your product connect a third-party account and execute Connector actions for that user from your backend.
- [Connector for SaaS guide](https://oomol.com/en/docs/connector-saas.md): Let a SaaS product connect third-party accounts for end users and execute Connector actions from the backend.
- [Connect end-user accounts with ProjectConnector](https://oomol.com/en/docs/project-connector.md): Use ProjectConnector in a TypeScript backend to connect accounts for SaaS users and execute actions on their behalf.

## OpenConnector

Use these guides to deploy OpenConnector, protect the runtime, and configure provider OAuth apps inside your own environment.

- [OpenConnector overview](https://oomol.com/en/docs/openconnector.md): Run the open-source Connector runtime in your own environment and control credential storage, provider access, and action policy.
- [OOMOL OpenConnector self-hosting guide](https://oomol.com/en/docs/openconnector-self-hosting.md): Self-host the open-source connector service, protect local credentials, configure provider connections, and expose actions to agents through MCP or HTTP.
- [Call a self-hosted runtime with OpenConnector](https://oomol.com/en/docs/openconnector-sdk.md): Use the OpenConnector TypeScript client to call actions, inspect the catalog, and select connections on your own runtime.
- [OpenConnector OAuth app setup guide](https://oomol.com/en/docs/openconnector-oauth-apps.md): Create a provider OAuth app, configure its redirect URI, and connect it to a self-hosted OOMOL OpenConnector runtime.
- [Create a Google OAuth app for OpenConnector](https://oomol.com/en/docs/openconnector-google-oauth-app.md): Create Google OAuth credentials for Gmail, Drive, Calendar, Sheets, Docs, Slides, YouTube, Analytics, BigQuery, and other Google providers in OOMOL OpenConnector.
- [Create a Slack OAuth app for OpenConnector](https://oomol.com/en/docs/openconnector-slack-oauth-app.md): Create a Slack app, configure OAuth redirect URLs and scopes, then connect Slack to a self-hosted OOMOL OpenConnector runtime.
- [Create a HubSpot MCP auth app for OpenConnector](https://oomol.com/en/docs/openconnector-hubspot-oauth-app.md): Create a HubSpot MCP auth app, configure the OpenConnector redirect URL, and connect HubSpot through OAuth.
- [Create a GitHub OAuth app for OpenConnector](https://oomol.com/en/docs/openconnector-github-oauth-app.md): Create a GitHub OAuth app, configure the callback URL, and connect GitHub to a self-hosted OOMOL OpenConnector runtime.
- [Create a Microsoft OAuth app for OpenConnector](https://oomol.com/en/docs/openconnector-microsoft-oauth-app.md): Register a Microsoft Entra application for Outlook, OneDrive, Excel, and other Microsoft Graph providers in OOMOL OpenConnector.
- [Create a Notion OAuth app for OpenConnector](https://oomol.com/en/docs/openconnector-notion-oauth-app.md): Create a Notion public connection, configure its OAuth redirect URI, and connect Notion to OOMOL OpenConnector.

## Reference

Use this reference for shared TypeScript SDK configuration, precise action types, errors, and the complete API surface across Connector clients.

- [OOMOL TypeScript SDK reference](https://oomol.com/en/docs/connector-sdk.md): Reference the shared configuration, types, errors, and API surface for Connector, ProjectConnector, and OpenConnector.

## App Connections & Permissions

Use these guides to review connection steps, permissions, data handling, and removal for specific third-party Apps.

- [monday.com App Guide](https://oomol.com/en/docs/monday.md): How to add, use, troubleshoot, and remove the monday.com app in OOMOL.
- [HubSpot App Guide](https://oomol.com/en/docs/hubspot.md): How to add, use, troubleshoot, and remove the HubSpot app in OOMOL.
- [Slack App Guide](https://oomol.com/en/docs/slack.md): How to add, use, troubleshoot, and remove the Slack app in OOMOL.
- [Zoom App Guide](https://oomol.com/en/docs/zoom.md): How to add, use, troubleshoot, and remove the Zoom app in OOMOL.

## Comparison Guides

Use these guides when comparing OOMOL with similar connector and agent tool platforms before choosing a runtime boundary.

- [OOMOL vs Composio](https://oomol.com/en/docs/oomol-vs-composio.md): Compare OOMOL with Composio for hosted connector actions, self-hosting, Cloudflare deployment, and connector runtime ownership.
- [OOMOL vs Pipedream](https://oomol.com/en/docs/oomol-vs-pipedream.md): Compare OOMOL with Pipedream for hosted workflows, Pipedream Connect, MCP, Cloudflare deployment, and connector runtime ownership.

## Additional Docs

- [Access control](https://oomol.com/en/docs/access-control.md): Learn how to manage Provider authorization, connection access, and callable actions.
- [Team management](https://oomol.com/en/docs/team-management.md): Create and switch Teams, manage member roles, and control which App connections members can use.

## Blog

Longer-form articles on agent integrations, tool ownership, and OOMOL plans.

- [From Meta Muse to Leina: AI Assistants Need Access to Your World](https://oomol.com/en/blog/meta-muse-ai-assistant-oomol.md): Explore how personal and team AI assistants use context across apps, and how OOMOL and open-source OpenConnector provide account connections, authorization, and app operations.
- [Teach AI to Choose: 5 Agent Skill Ideas Inspired by Jev](https://oomol.com/en/blog/jev-agent-skills.md): Explore five Jev use cases, from music and game NPCs to Skill routing, and connect its decision-making capabilities to your Agent workflows through OOMOL’s Cloudflare Workers AI Provider.
- [One Key Plan: One Key, Many Services on Demand](https://oomol.com/en/blog/one-key-plan.md): Use video, image, audio and data services through one OOMOL Key. Reduce separate subscriptions and payment setup, benefit from volume pricing, and tell AI what you need.
- [OpenConnector, Composio, Nango and Pipedream: How Much Is Open Source?](https://oomol.com/en/blog/openconnector-comparison.md): Compare source code, self-hosting and licenses across four agent integration tools, then see how to add a provider and move from OOMOL SaaS to your own runtime.

## Optional

- [OOMOL Spectrum](https://oomol.com/design.md): Brand, design, and writing guidance.