> ## Documentation Index
> Fetch the complete documentation index at: https://nayax-44d6e37b-spark-html-tool.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect to the Nayax MCP Server

[Model Context Protocol (MCP)](https://modelcontextprotocol.io) is an open standard that lets AI coding assistants
connect to external data sources and tools.

The Nayax developer portal includes an MCP server.
Connect your AI assistant to it, and it can read and search
Nayax documentation in real time, giving you accurate answers about Nayax
APIs, SDKs, and integration flows without leaving your editor.

## Prerequisites

Before you begin, you'll need an MCP-compatible AI tool to act as the client host.
Common options include Claude desktop, Claude Code, Cursor, and VS Code with GitHub Copilot (Agent mode).

## Connect to the Nayax MCP Server

See how you can connect to our MCP server through different tools:

<Tabs>
  <Tab title="Claude">
    <Steps>
      <Step title="Open Connectors settings">
        In Claude, go to [**Settings** → **Connectors**](https://claude.ai/settings/integrations) and select **Add custom connector**.
      </Step>

      <Step title="Enter the server details">
        Set the name to `nayax` and the URL to `https://devzone.nayax.com/mcp`, then click **Add**.
      </Step>

      <Step title="Attach the server in chat">
        To attach the server to your conversation:

        1. Start a new conversation.
        2. Select the attachments icon (the plus icon next to the input).
        3. Choose the `nayax` connector.
      </Step>

      <Step title="Verify the connection">
        Ask a Nayax-related question such as:

        ```
        What authentication method does the Lynx API use?
        ```

        Claude should respond with information pulled directly from the Nayax developer portal.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Claude Code">
    <Steps>
      <Step title="Add the server via the CLI">
        Run the following command in your terminal:

        ```bash theme={null}
                claude mcp add --transport http nayax https://devzone.nayax.com/mcp
        ```

        This registers the server globally across all your Claude Code sessions. For more on managing MCP servers in Claude Code, see the [Claude Code MCP documentation](https://docs.anthropic.com/en/docs/claude-code/mcp).
      </Step>

      <Step title="Verify the connection">
        Start a Claude Code session and ask a Nayax-related question. To confirm the server is registered, run:

        ```bash theme={null}
                claude mcp list
        ```

        The `nayax` server should appear in the output.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Cursor">
    <Steps>
      <Step title="Open MCP settings">
        1. Press `Cmd+Shift+P` (macOS) or `Ctrl+Shift+P` (Windows/Linux) to open the command palette.
        2. Search for **Open MCP settings**.
        3. Select **Add custom MCP**. This opens the `mcp.json` file.

        For more details, see the [Cursor MCP documentation](https://cursor.com/docs/context/mcp).
      </Step>

      <Step title="Add the Nayax MCP server">
        In `mcp.json`, add the following configuration. If you already have other servers configured, add the `nayax` entry inside the existing `mcpServers` object.

        ```json ~/.cursor/mcp.json theme={null}
        {
          "mcpServers": {
            "nayax": {
              "url": "https://devzone.nayax.com/mcp"
            }
          }
        }
        ```
      </Step>

      <Step title="Save and restart Cursor">
        Save the file. Cursor detects the new server automatically on the next start.
      </Step>

      <Step title="Verify the connection">
        To verify the connection, open Cursor Chat and ask a Nayax-related question. The server name `nayax` appears in the tool list when MCP is active.
      </Step>
    </Steps>
  </Tab>

  <Tab title="VS Code">
    <Steps>
      <Step title="Open your workspace MCP configuration">
        In your project root (the top-level folder of your project),
        create or open a file called `.vscode/mcp.json`.
      </Step>

      <Step title="Add the Nayax MCP server">
        Paste the following configuration:

        ```json .vscode/mcp.json theme={null}
                {
                  "servers": {
                    "nayax": {
                      "type": "http",
                      "url": "https://devzone.nayax.com/mcp"
                    }
                  },
                  "inputs": []
                }
        ```
      </Step>

      <Step title="Reload the window">
        Press `Ctrl+Shift+P` (Windows/Linux) or `Cmd+Shift+P` (macOS),
        then run **Developer: Reload Window**.
      </Step>

      <Step title="Verify the connection">
        Open your AI assistant in VS Code and ask a question about a Nayax API, such as:

        ```
          How do I start a session with the Marshall SDK?
        ```

        Your assistant should answer using content from the Nayax developer portal.

        <Note>
          If you are using GitHub Copilot, make sure you are in [**Agent mode**](https://code.visualstudio.com/docs/copilot/chat/mcp-servers). You can switch to it by selecting it from the dropdown at the bottom of the chat input.
        </Note>
      </Step>
    </Steps>
  </Tab>
</Tabs>

## What you can do with the MCP server

Once connected, your AI assistant can:

* Search and retrieve content from any page in the Nayax developer portal
* Answer questions about specific API endpoints, request parameters, and response fields
* Explain integration flows, payment sessions, and SDK configuration options
* Surface code examples from guides such as Marshall, Cortina, EMV Core, and the eCom SDK

<Tip>
  For best results, be specific in your prompts. For example, ask "How do I handle a declined transaction in the Cortina prepaid card flow?" rather than a broad question like "Tell me about Cortina."
</Tip>

## Troubleshooting

These are some common errors you might encounter while setting up the Nayax MCP and how to solve them:

<AccordionGroup>
  <Accordion title="The MCP server does not appear in my tool list.">
    Confirm that:

    * The JSON in your configuration file is valid (no trailing commas, all braces closed).
    * You reloaded or restarted the editor after saving the file.
    * Your network can reach `https://devzone.nayax.com`.
  </Accordion>

  <Accordion title="The assistant returns outdated or incorrect information.">
    The MCP server reflects the published state of the Nayax developer portal. If documentation was recently updated, try starting a new conversation so the assistant fetches a fresh context.
  </Accordion>

  <Accordion title="I see an authentication error.">
    The Nayax MCP server does not require authentication. If you see an auth error, check whether a proxy or firewall is intercepting HTTPS requests to `devzone.nayax.com`.
  </Accordion>
</AccordionGroup>