# smoxy MCP Server

smoxy documentation is available as a **Model Context Protocol (MCP)** server. This allows AI assistants like Claude, Cursor, and VS Code Copilot to search and retrieve smoxy documentation directly — so you can ask questions about smoxy features, configuration, and API usage without leaving your development environment.

***

### What is MCP?

The [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) is an open standard that allows AI assistants to connect to external data sources. With the smoxy MCP server, your AI assistant can:

* Search through the full smoxy documentation
* Retrieve specific documentation pages
* Answer questions using up-to-date smoxy content

***

### MCP Endpoint

The smoxy MCP server is available at:

```
https://docs.smoxy.eu/~gitbook/mcp
```

This endpoint uses **HTTP transport** and provides read-only access to all published smoxy documentation.

***

### Setup

#### Claude Desktop

Add the following to your Claude Desktop MCP configuration file (`claude_desktop_config.json`):

```json
{
  "mcpServers": {
    "smoxy": {
      "type": "url",
      "url": "https://docs.smoxy.eu/~gitbook/mcp"
    }
  }
}
```

#### Claude Code (CLI)

Add the smoxy MCP server to your project or user settings:

```bash
claude mcp add smoxy --transport http "https://docs.smoxy.eu/~gitbook/mcp"
```

#### Cursor

Add the MCP server in your Cursor settings under **MCP Servers**:

* **Name:** `smoxy`
* **Type:** `URL`
* **URL:** `https://docs.smoxy.eu/~gitbook/mcp`

#### VS Code

Add the following to your VS Code `settings.json` or `.vscode/mcp.json`:

```json
{
  "mcpServers": {
    "smoxy": {
      "type": "url",
      "url": "https://docs.smoxy.eu/~gitbook/mcp"
    }
  }
}
```

#### Other Tools

Any AI tool that supports MCP with HTTP transport can connect to the smoxy documentation. Use the endpoint URL `https://docs.smoxy.eu/~gitbook/mcp` in your tool's MCP configuration.

> **Note:** Tools that only support stdio or SSE transport are not compatible. The smoxy MCP server uses HTTP transport exclusively.

***

### Usage Examples

Once connected, you can ask your AI assistant questions like:

* "How do I configure cache tags in smoxy?"
* "What are the available protocols for log forwarding?"
* "How does SSL certificate renewal work in smoxy?"
* "What access rule conditions can I use in smoxy?"
* "How do I upload a custom error page via the smoxy API?"

The assistant will search the smoxy documentation and provide answers based on the latest published content.

***

### Important Considerations

* **Published content only:** The MCP server provides access to published documentation. Draft or unpublished changes are not available.
* **Read-only:** The MCP server only provides documentation search and retrieval. It does not expose any user data, analytics, or configuration from your smoxy account.
* **Always up to date:** The MCP server serves the latest published version of the documentation. When docs are updated, your AI assistant immediately has access to the new content.