# Guide to the iClosed MCP server

The iClosed **Model Context Protocol (MCP)** server lets compatible AI assistants securely query the **iClosed.io API documentation**—so they can look up endpoints, parameters, authentication, and examples using natural language, without you copying specs by hand.

For the protocol itself and how MCP clients work, see the official [Model Context Protocol introduction](https://modelcontextprotocol.io/docs/getting-started/intro).

## How it works

- **MCP** is an open standard for connecting AI clients to tools and data sources. The iClosed MCP server exposes our hosted API docs as **tools** your assistant can call.
- **You authenticate** with the same API key you use for the iClosed API (`Authorization: Bearer iclosed_<your-api-key>`). The server uses that access only to serve documentation-related responses through MCP—not to act on your production data on your behalf.
- **You connect** from a supported client (Claude Desktop, Cursor, or any MCP-compatible app). Each client has its own configuration file or UI; use the connector guides in this section’s sidebar.


**MCP endpoint (hosted):** `https://api-docs-iclosed.redocly.app/mcp`

## What assistants can do with this server

The server provides tools for exploring the documented API surface:

| Tool | Purpose |
|  --- | --- |
| **search** | Search across the documentation for phrases or terms relevant to your question. |
| **list-apis** | List available APIs (with optional name filter and pagination). |
| **get-endpoints** | List all endpoints for a named API. |
| **get-endpoint-info** | Get detailed information for a specific path and HTTP method (parameters, security, examples). |
| **get-full-api-description** | Retrieve the complete OpenAPI description for a named API. |
| **get-security-schemes** | Get security schemes (for example, how API keys are applied) for a named API. |


Together, these tools help assistants answer questions like “How do I create a contact?”, “What does this endpoint expect in the body?”, or “Which methods are available under deals?” using the same source of truth as this documentation site.

## Before you connect

1. **API key** — Create an API key in your iClosed account (see [Authentication](/docs/authentication)). The MCP server expects:

```http
Authorization: Bearer iclosed_<your-api-key>
```
2. **Treat keys as secrets** — Do not commit real keys to git, screenshots, or shared configs. Use environment-specific storage or your client’s secret fields where available.
3. **Network** — Your machine must reach `https://api-docs-iclosed.redocly.app` (corporate proxies or firewalls may need an allowlist).


## Connect from your AI assistant

Use the controls below to open this MCP server from a supported client or copy connection details for manual setup.

Step-by-step guides for common clients:

- **[Connect with Claude Desktop](/docs/mcp/mcp-connectors/claude)** — `claude_desktop_config.json` and `mcp-remote`.
- **[Connect with Cursor](/docs/mcp/mcp-connectors/cursor)** — `mcp.json` with URL and headers.
- **[Other MCP clients](/docs/mcp/mcp-connectors/other-clients)** — VS Code–style setups, generic HTTP MCP, and troubleshooting.


If your app is not listed, it may still work if it supports **remote MCP over HTTP** with custom headers; use the same endpoint and `Authorization` header as above and follow that product’s MCP documentation.

## Verify the connection

After configuration, restart the client if required, then:

- Open a new chat and ask the assistant to use the iClosed MCP tools (for example: “List APIs available from the iClosed MCP server” or “Search the docs for contacts”).
- If your client shows an MCP or “tools” panel, confirm the iClosed server is connected and not reporting authentication errors.


## Privacy and security

- Your API key is sent to the **hosted documentation MCP endpoint** over HTTPS. Store it only in trusted client configuration.
- Rotate keys if they are exposed. See [Authentication](/docs/authentication) for key management practices.
- This MCP server is for **documentation discovery**. It does not replace direct API calls to `https://public.api.iclosed.io` for your application logic.


## Related documentation

- [Webhooks](/docs/webhooks/introduction) — Real-time HTTP callbacks from iClosed (separate from MCP).
- [Authentication](/docs/authentication) — API keys and request signing context.
- [API Reference](/docs/api-reference) — Human-readable entry point to the OpenAPI reference.