> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oumi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CONNECT YOUR AI ASSISTANT

> Install the Oumi plugin in Claude, ChatGPT, Codex, or Hermes, sign in, and work in your Oumi projects from chat

The Oumi plugin connects an AI assistant to the Oumi MCP server at `https://api.oumi.ai/mcp`. You ask the assistant in plain language, and it looks up your datasets, models, and evaluations, prepares data, and starts the jobs you approve.

You sign in with your own Oumi account. The assistant sees only the organizations and projects that you can see, and jobs that cost money use your organization's Oumi billing. The plugin stores no credentials. The plugin's source is in the [oumi-plugins](https://github.com/oumi-ai/oumi-plugins) repository.

***

## INSTALL THE PLUGIN

> [tab] Claude Code
>
> ```bash theme={null}
> claude plugin marketplace add oumi-ai/oumi-plugins
> claude plugin install oumi-platform@oumi
> ```
>
> Start a new session after the install.

> [tab] Codex
>
> ```bash theme={null}
> codex plugin marketplace add oumi-ai/oumi-plugins
> codex plugin add oumi-platform@oumi
> ```
>
> Start a new session after the install.

> [tab] Claude app
>
> 1. Open **Settings > Connectors** and click **Add custom connector**.
> 2. Enter `Oumi` as the name and `https://api.oumi.ai/mcp` as the URL.
> 3. Click **Add**, then click **Connect** to sign in.

> [tab] ChatGPT
>
> 1. Open **Plugins**, click **+**, and choose **Add custom MCP server**.
> 2. Enter `https://api.oumi.ai/mcp` as the URL and choose **OAuth** authentication.
> 3. Save the server, then sign in when ChatGPT asks.

> [tab] Hermes
>
> Add the server to `~/.hermes/config.yaml`:
>
> ```yaml theme={null}
> mcp_servers:
>   oumi:
>     url: "https://api.oumi.ai/mcp"
>     auth: oauth
> ```
>
> Then sign in:
>
> ```bash theme={null}
> hermes mcp login oumi
> ```

> [tab] Other MCP clients
>
> Any client that supports remote MCP servers with OAuth can connect:
>
> | Setting | Value |
> | - | - |
> | Transport | Streamable HTTP |
> | URL | `https://api.oumi.ai/mcp` |
> | Authentication | OAuth 2.1 with dynamic client registration. Leave the client ID and secret empty. |
>
> For a client that reads a JSON config:
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "oumi-platform": {
>       "type": "http",
>       "url": "https://api.oumi.ai/mcp"
>     }
>   }
> }
> ```

***

## SIGN IN

The first time the assistant calls an Oumi tool, it opens the Oumi sign-in page in your browser. Sign in with your Oumi account and click **Allow Access**. The assistant keeps the session, so you sign in once per client.

To confirm the connection, ask:

```text theme={null}
List my Oumi organizations and projects.
```

***

## WORK IN A PROJECT

Tell the assistant which organization and project to use at the start of a conversation. It then works in that project until you name another one.

For example:

```text theme={null}
In my Oumi project "support-intents", compare the scores of the last three evaluations and tell me which model to deploy.
```

The assistant can:

* Look up projects, datasets, models, evaluations, evaluators, recipes, deployments, monitors, and operations
* Upload, sample, merge, and version datasets
* Create evaluators and training recipes
* Start [training](https://docs.oumi.ai/guides/training.md), [evaluation](https://docs.oumi.ai/guides/evaluations.md), [deployment](https://docs.oumi.ai/guides/deployment.md), and [synthesis](https://docs.oumi.ai/guides/synthesis.md) jobs, and stop them

Every job that the assistant starts appears in the Oumi app, where you can follow its progress. Ask the assistant to check on a long-running job, or open it from the [jobs](https://docs.oumi.ai/guides/jobs.md) page.

> [!WARNING]
>
> Training, evaluation, deployment, and synthesis jobs use your organization's Oumi billing. Read the assistant's plan before you approve a job, and ask it to stop any job that you did not intend to start.

***

## TROUBLESHOOTING

**The assistant asks you to sign in again.** Your session expired. Sign in again from the link that the assistant shows.

**The assistant cannot find a project.** Ask it to list your organizations and projects, and check that your Oumi account is a member of the project. See [organizations and projects](https://docs.oumi.ai/admin/org-projects.md).

**The tools do not appear after the install.** Start a new session in Claude Code, Codex, or Hermes. In the Claude app and ChatGPT, check that the connector is turned on for the conversation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.