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 (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/mcp

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

---

Available Tools

The server exposes exactly two tools, and both of them only read documentation:

Tool	Parameter	What it does
searchDocumentation	query (string, required)	Searches the full documentation and returns matching titles, short excerpts, and direct links to the pages. Excerpts are truncated - use getPage to read the full page.
getPage	url (string, required)	Returns the complete markdown of a single documentation page. Accepts a full URL as returned by searchDocumentation, or an absolute path such as /getting-started.

There are no other tools, and no resources or prompts. In particular, the MCP server cannot perform any action on a smoxy account: it cannot list or change zones, clear caches, manage certificates, or read traffic statistics. Those operations run through the smoxy API with an API token - the MCP server knows nothing about accounts and requires no authentication.

---

Setup

Claude Desktop

Claude Desktop connects to remote HTTP MCP servers through Custom Connectors:

1. Open Settings → Connectors.
2. Scroll to the bottom and click Add custom connector.
3. Enter a name (for example smoxy) and the URL https://docs.smoxy.eu/mcp.
4. Click Add.

Alternatively, if you prefer editing claude_desktop_config.json directly, bridge the remote endpoint with mcp-remote:

{
  "mcpServers": {
    "smoxy": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://docs.smoxy.eu/mcp"]
    }
  }
}

Claude Code (CLI)

Add the smoxy MCP server. --scope user registers it for every project - without that flag, the server is only available in the current project:

claude mcp add smoxy --scope user --transport http "https://docs.smoxy.eu/mcp"

Cursor

Add the following to your Cursor MCP configuration - ~/.cursor/mcp.json for all projects, or .cursor/mcp.json inside a specific project. A remote HTTP server needs only the url field:

{
  "mcpServers": {
    "smoxy": {
      "url": "https://docs.smoxy.eu/mcp"
    }
  }
}

VS Code

Add the following to .vscode/mcp.json in your workspace (or your user configuration via the MCP: Open User Configuration command). VS Code uses a top-level servers key, and remote servers use "type": "http":

{
  "servers": {
    "smoxy": {
      "type": "http",
      "url": "https://docs.smoxy.eu/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/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 - see Available Tools. It does not expose any user data, analytics, or configuration from your smoxy account, and it cannot change anything in it.
• 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.