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

# Quickstart

> Connect the Zero MCP server to your AI work tools.

## Cloud MCP endpoint

Zero hosts a remote MCP server. There is no infrastructure to run; point your client at:

```text theme={null}
https://api.zdlake.com/mcp
```

## Configuration

Add the Zero MCP server to your work tool. Hosted platforms and supported CLI clients use OAuth, so you authorize through your Zero account without pasting an API key.

> [tab] Claude
>
> 1. Go to [Claude connectors](https://claude.ai/settings/connectors) and select **Add custom connector**.
> 2. Set the name to **Zero**.
> 3. Set **Remote MCP server URL** to `https://api.zdlake.com/mcp`.
> 4. Select **Add** and sign in to Zero when prompted.
>
> Claude discovers OAuth automatically and asks you to authorize access to a Zero organization.

> [tab] Claude Cowork
>
> 1. Open **Settings > Connectors** and select **Add custom connector**.
> 2. Set the name to **Zero**.
> 3. Set **Remote MCP server URL** to `https://api.zdlake.com/mcp`.
> 4. Select **Add** and sign in to Zero when prompted.
>
> Cowork discovers OAuth automatically and asks you to authorize access to a Zero organization.

> [tab] ChatGPT
>
> 1. Open [ChatGPT settings](https://chatgpt.com/settings#settings), select **Apps**, and enable **Developer mode** under advanced settings.
> 2. Select **Create app**.
> 3. Set the name to **Zero**.
> 4. Set **MCP Server URL** to `https://api.zdlake.com/mcp`.
> 5. Set authentication to **OAuth**, confirm the connection, and select **Create**.
>
> ChatGPT discovers the authorization endpoints and opens the Zero consent screen.

> [tab] Codex
>
> Add the server and complete OAuth login:
>
> ```bash theme={null}
> codex mcp add zero \
>   --url "https://api.zdlake.com/mcp" \
>   --oauth-resource "https://api.zdlake.com/mcp"
>
> codex mcp login zero --scopes catalog:read
> ```
>
> Codex opens your browser for Zero authorization and stores the resulting OAuth credentials.

> [tab] Claude Code
>
> Add the server and complete OAuth login:
>
> ```bash theme={null}
> claude mcp add --transport http --scope user \
>   zero "https://api.zdlake.com/mcp"
>
> claude mcp login zero
> ```
>
> Claude Code opens your browser for Zero authorization. Use `--no-browser` with `claude mcp login` for a headless session.

> [tab] Microsoft Copilot
>
> 1. Open your agent in [Copilot Studio](https://copilotstudio.microsoft.com/) and go to **Tools > Add a tool > New tool > Model Context Protocol**.
> 2. Set **Server name** to **Zero** and **Server URL** to `https://api.zdlake.com/mcp`.
> 3. Set authentication to **OAuth 2.0** with **Dynamic discovery**.
> 4. Select **Create** and sign in to Zero when prompted.

## Authorization

During OAuth, Zero shows the requesting client, the `catalog:read` permission, and the organizations available to your account. Select the organization the client should access and approve the request.

Access tokens expire after one hour. Supported clients refresh them automatically with a rotating refresh token. See [OAuth 2.1](https://docs.zdlake.com/mcp/oauth.md) for the complete protocol.

## API-key alternative

Use an API key for CI or another non-interactive client that cannot complete OAuth:

```bash theme={null}
export ZERO_API_KEY="sk_your_key"
codex mcp add zero \
  --url "https://api.zdlake.com/mcp" \
  --bearer-token-env-var ZERO_API_KEY
```

> [!WARNING]
>
> Never commit API keys to version control. OAuth is the preferred method for interactive clients.

## Verify the connection

Test the integration with:

```text theme={null}
Search Zero for critical Log4j vulnerabilities and summarize the affected software.
```

The client should use `search` to discover the vulnerability operation and `execute` to run it.

## Troubleshooting

| Symptom | What to check |
| - | - |
| `401 Unauthorized` | Run the client's MCP login command again or reconnect the hosted integration. |
| `403 Forbidden` | Reauthorize and select an organization that can access the requested data. |
| `429 Too Many Requests` | Wait for the `Retry-After` interval before reconnecting or retrying. |
| Tools are missing | Restart the client after adding or authorizing the MCP server. |
| Connection fails | Confirm the URL is exactly `https://api.zdlake.com/mcp` and the client supports Streamable HTTP. |

> [card] [Tools](https://docs.zdlake.com/mcp/tools.md)
>
> Review the `search` and `execute` schemas and example calls.

> [card] [OAuth 2.1](https://docs.zdlake.com/mcp/oauth.md)
>
> Review discovery, registration, PKCE, token rotation, and revocation.

> [card] [Rate limits](https://docs.zdlake.com/mcp/rate-limits.md)
>
> Understand MCP quotas and retry behavior.


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