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

# Connect Your AI Assistant to Equip

> Let Claude Code, Codex, Gemini CLI, Cursor or VS Code look up your openings, candidates, assessments and interviews through Equip's MCP server.

Equip has a remote **MCP server** at `https://equip.co/api/v3/mcp/`. Connect your AI coding assistant to it and ask questions in plain language, such as "which of my job openings have the most candidates waiting in screening?". The server is **read-only**: your assistant can look things up, and nothing is ever written or changed.

Available on the annual Premium and Elite plans.
[Compare plans](https://help.equip.co/compare-plans.md)

If your plan does not include it, [contact support](https://help.equip.co/contact-support.md) and we can switch it on for your organization. Until then the Developers page shows an upgrade prompt in place of **Connect your AI assistant**.

## Get Your Organization's API Key

Every request to the MCP server carries your organization's **API Key**. An organization **Owner or Admin** generates it.

**1. Open the Developers page**

Go to [**Account → Developers**](https://equip.co/recruiter/account/developers/).

**2. Generate the key**

Click **Generate API Key** and copy the key (`eqp_...`). It is shown only once; if you lose it, click **Rotate API Key** to get a new one.

**3. Put the key in your shell**

Add this line to your shell profile (`~/.zshrc` or `~/.bashrc`) so it survives new terminals:

```sh theme={null}
export EQUIP_MCP=eqp_your_api_key
```

The variable is named `EQUIP_MCP` on purpose. Claude Code blanks any variable whose name contains KEY, TOKEN or SECRET when it fills in a remote server's headers, so a name like `EQUIP_API_KEY` would silently fail.

![The API Key card on the Account Developers page, before a key exists, with the Generate API Key button](https://mintcdn.com/equip-hq/hQF868N9i7xn4NG3/images/connect-ai-assistant/developers-api-key.png?fit=max\&auto=format\&n=hQF868N9i7xn4NG3\&q=85\&s=e7209d87d4450d7c79d24fe643f8d25f)

The API Key card on the Developers page

> [!WARNING]
>
> The key is one key for the whole organization, not a personal login, and it acts as the organization's admin: an assistant holding it can read everything an admin can, across every opening. Share it only with people who may see all of that, and rotate it if it leaks.

## Pick Your Client

Each client has its own setup page with a copy-ready snippet and a check that the connection works.

> [card] [Claude Code](https://help.equip.co/mcp-claude-code.md)
>
> One `claude mcp add` command.

> [card] [Codex](https://help.equip.co/mcp-codex.md)
>
> Three lines in `~/.codex/config.toml`.

> [card] [Gemini CLI](https://help.equip.co/mcp-gemini-cli.md)
>
> One entry in `~/.gemini/settings.json`.

The same snippets, and the full list of tools, are on [**Account → Developers**](https://equip.co/recruiter/account/developers/) under **Connect your AI assistant**.

![The Connect your AI assistant section on the Account Developers page, showing the server URL, tabs for Claude Code, Cursor, VS Code, Codex and curl with Claude Code selected, and the claude mcp add command ready to copy](https://mintcdn.com/equip-hq/hQF868N9i7xn4NG3/images/connect-ai-assistant/developers-connect-section.png?fit=max\&auto=format\&n=hQF868N9i7xn4NG3\&q=85\&s=b5ecc0cf2ad242873cbd4d1344d4d567)

Connect your AI assistant on the Developers page, one tab per client

### Cursor and VS Code

Both read the key from your environment or prompt you for it, so the key is never written into a config file.

> [accordion] Cursor
>
> Add this to `.cursor/mcp.json` in your project, or use the **Add to Cursor** link on the Developers page.
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "equip": {
>       "url": "https://equip.co/api/v3/mcp/",
>       "headers": {
>         "Authorization": "Bearer ${env:EQUIP_MCP}"
>       }
>     }
>   }
> }
> ```

> [accordion] VS Code
>
> Add this to `.vscode/mcp.json`. VS Code asks for the key the first time the server starts and stores it securely.
>
> ```json theme={null}
> {
>   "inputs": [
>     {
>       "type": "promptString",
>       "id": "equip-api-key",
>       "description": "Equip API key (eqp_...)",
>       "password": true
>     }
>   ],
>   "servers": {
>     "equip": {
>       "type": "http",
>       "url": "https://equip.co/api/v3/mcp/",
>       "headers": {
>         "Authorization": "Bearer ${input:equip-api-key}"
>       }
>     }
>   }
> }
> ```

## What Your Assistant Can Read

The tools mirror what a recruiter sees in Equip, grouped by area.

| Group | Example tools |
| - | - |
| **Job openings** | `list_job_openings`, `get_job_post_stage_counts` |
| **Candidates and applications** | `find_candidate`, `list_job_applications` |
| **Assessments and results** | `list_assessment_results`, `get_assessment_scores_for_applications` |
| **Interviews** | `list_ai_interviews`, `list_live_interviews` |
| **Organization** | `list_organization_members`, `get_ats_insight` |

The full list is on [**Account → Developers**](https://equip.co/recruiter/account/developers/) under **Connect your AI assistant**. A few tools appear only when your plan includes the matching feature, such as ATS Insights.

## Any Other MCP Client

Any client that speaks **Streamable HTTP** can connect. It sends JSON-RPC 2.0 requests as `POST` to `https://equip.co/api/v3/mcp/` with the key in an `Authorization: Bearer eqp_...` header (an `X-API-Key: eqp_...` header also works). There is no SSE stream and no session: a `GET` or `DELETE` to the URL is refused.

Check the connection from a terminal:

```sh theme={null}
curl -X POST https://equip.co/api/v3/mcp/ \
  -H "Authorization: Bearer $EQUIP_MCP" \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
```

> [accordion] Troubleshooting
>
> * **401 Invalid API key**: the key was mistyped or rotated, or `EQUIP_MCP` is not exported in this shell. Run `echo $EQUIP_MCP` to check.
> * **403 "isn't included in your plan"**: your plan does not include the MCP server. See [Compare Plans](https://help.equip.co/compare-plans.md), or [contact support](https://help.equip.co/contact-support.md) to have it switched on for your organization.
> * **No tools, or an empty list**: restart the client after adding the server.

## Related Resources

* [Claude Code](https://help.equip.co/mcp-claude-code.md) - Add Equip to Claude Code with one command
* [Codex](https://help.equip.co/mcp-codex.md) - Add Equip to Codex's config.toml
* [Gemini CLI](https://help.equip.co/mcp-gemini-cli.md) - Add Equip to Gemini CLI's settings.json
* [API Integrations](https://help.equip.co/api-integrations.md) - The REST API behind the same key, for inviting candidates and pulling results


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