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

# PlungeAI API Overview

> Connect PlungeAI to your coding agent, onboard it, and build on the One API and the MCP server.


## Set up PlungeAI via MCP

One server, 20 tools. Needs an ozk_ key from Dashboard → One API → Keys. Works in every major coding agent.

[See all install options →](/developer-tools/mcp/quickstart)

<Tabs>
<Tab title="Claude Code">
**Run in terminal.** Run this command in your terminal. Set PLUNGE_API_KEY first; the header is stored in your Claude Code config.

```bash
claude mcp add --transport http plungeai https://mcp.plungeai.com/v1 --header "Authorization: Bearer $PLUNGE_API_KEY"
```

**Verify installation:** Run /mcp to see plungeai, then ask: use plungeai_whoami to confirm my identity

[Learn more](/integrations/claude-code)
</Tab>
<Tab title="Codex">
**Run in terminal.** Run this command in your terminal. Codex reads the key from PLUNGEAI_API_KEY at run time: export PLUNGEAI_API_KEY=$PLUNGE_API_KEY.

```bash
codex mcp add plungeai --url https://mcp.plungeai.com/v1 --bearer-token-env-var PLUNGEAI_API_KEY
```

**Verify installation:** /mcp lists plungeai

[Learn more](/integrations/codex)
</Tab>
<Tab title="Cursor">
**One-click install.** Add PlungeAI to Cursor: [Add to Cursor →](https://mcp.plungeai.com/install/cursor)

Then add the Authorization header in ~/.cursor/mcp.json (user-level file, never a repo file).

**Verify installation:** In agent chat: use plungeai_whoami to confirm my identity

[Learn more](/integrations/cursor)
</Tab>
<Tab title="VS Code">
**One-click install.** Add PlungeAI to VS Code: [Add to VS Code →](https://mcp.plungeai.com/install/vscode)

Or from a terminal:

```bash
code --add-mcp "{\"name\":\"plungeai\",\"type\":\"http\",\"url\":\"https://mcp.plungeai.com/v1\",\"headers\":{\"Authorization\":\"Bearer $PLUNGE_API_KEY\"}}"
```

**Verify installation:** In Copilot agent chat: plungeai_whoami

[Learn more](/integrations/vscode)
</Tab>
</Tabs>

<Note>
These docs use PLUNGE_API_KEY; the PlungeAI skills, the Claude Code plugin and the install page use PLUNGEAI_API_KEY; any name works if your config and shell agree.
</Note>

## Onboard your agent

Connect PlungeAI by pasting this prompt to your agent.

```text
Use curl to read https://docs.plungeai.com/agents.md and perform the setup to connect PlungeAI
```

The file it reads, [/agents.md](/agents.md), asks you for a key, connects your client to the MCP server, verifies the connection with `plungeai_whoami` and lists the rules the agent follows.

## Build with PlungeAI APIs

Pick a product and open its quickstart. Not sure which API to use? Try the [API chooser](/getting-started/choose-an-api).

[Create an API key](https://dashboard.plungeai.com/one-api?tab=keys)

<CardGroup cols={2}>
<Card title="Call any model" icon="cpu" href="/models/quickstart">
OpenAI-compatible chat with fallback and presets. Key: `sk-ocean-`.
</Card>
<Card title="Run a tool" icon="wrench" href="/tools/quickstart">
A typed tool call behind a trust fence. Key: `ozk_`.
</Card>
<Card title="Run an agent" icon="robot" href="/agents/quickstart">
One prompt, sync, async or streamed. Key: `ozk_`.
</Card>
<Card title="Run a workflow" icon="workflow" href="/workflows/quickstart">
Multi-agent CNL pipelines, inline or saved. Key: `ozk_`.
</Card>
<Card title="Run a bounded mission" icon="rocket" href="/missions/quickstart">
An agent loop inside allowed tools and iterations. Key: `ozk_`.
</Card>
<Card title="Schedule a job" icon="calendar" href="/scheduling/quickstart">
Cron agents, heartbeats and notifications. Key: `ozk_`.
</Card>
<Card title="Discover capabilities" icon="search" href="/discovery/quickstart">
Find agents, tools and models before you call. Key: `ozk_`.
</Card>
</CardGroup>

<!-- Cards: Appendix A §2.3 tab titles, taglines and "View docs" targets, in its order (Appendix C F-179, F-180, F-182); keys per orchestration/api-gateway/docs/guide-3.0/00-overview.md "The seven planes". The MCP server is the first section of this page, so it has no card here. Icons: ICON_NAMES of Task 3.1. -->
