MCP Integration Guide

The UQPAY Developer Docs site supports the Model Context Protocol (MCP), an open standard that allows AI assistants to access external data sources directly. By connecting your AI coding tool to the UQPAY MCP server, you can search and retrieve documentation without leaving your development environment.

What you can do with MCP

Once connected, your AI assistant can:

Search across all UQPAY documentation for guides, API references, and code examples
Retrieve the full content of any documentation page
Answer questions about UQPAY products, APIs, and integration patterns using up-to-date documentation

Prerequisites

A UQPAY sandbox or production account
An AI tool that supports MCP, such as:

Setup

The UQPAY MCP server endpoint is:

https://developers.uqpay.com/mcp

Claude Desktop
Claude Code
Cursor
Windsurf
VS Code (Copilot)

Open your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json

Add the following to the mcpServers object:

{
  "mcpServers": {
    "uqpay-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://developers.uqpay.com/mcp"
      ]
    }
  }
}

Restart Claude Desktop to apply the changes.

Run the following command in your terminal:

claude mcp add uqpay-docs -- npx -y mcp-remote https://developers.uqpay.com/mcp

Open Cursor Settings and navigate to the MCP section, then add a new MCP server with:

Name: uqpay-docs
Type: command
Command: npx -y mcp-remote https://developers.uqpay.com/mcp

Alternatively, add the following to your project’s .cursor/mcp.json:

{
  "mcpServers": {
    "uqpay-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://developers.uqpay.com/mcp"
      ]
    }
  }
}

Open Windsurf Settings and navigate to Cascade > MCP, then add a new server with:

{
  "mcpServers": {
    "uqpay-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://developers.uqpay.com/mcp"
      ]
    }
  }
}

Add the following to your VS Code settings.json or the project-level .vscode/mcp.json:

{
  "mcp": {
    "servers": {
      "uqpay-docs": {
        "command": "npx",
        "args": [
          "-y",
          "mcp-remote",
          "https://developers.uqpay.com/mcp"
        ]
      }
    }
  }
}

Available tools

The MCP server provides two tools:

Tool	Description
`search_uqpay_developer_docs`	Search across the documentation for relevant guides, API references, and code examples. Returns contextual snippets with page titles and direct links.
`get_page_uqpay_developer_docs`	Retrieve the full content of a specific page by its path. Use this when you need complete details rather than a search snippet.

A typical workflow is: search to find the relevant page, then get_page to retrieve the full content.

Example prompts

After connecting to the MCP server, try these prompts in your AI assistant:

Prompt	What it does
”How do I create a payout using the UQPAY Global Account API?”	Searches for payout guides and returns step-by-step instructions
”Show me the webhook payload for a card transaction event.”	Finds and retrieves the card transaction webhook documentation
”What parameters are required to create a virtual card?”	Looks up the card creation API reference
”List all supported currencies for cross-currency payouts.”	Retrieves the supported currency pairs reference
”How do I set up 3DS authentication for payments?”	Finds the 3DS integration guide

llms.txt

If your AI tool does not support MCP, you can use the llms.txt index to provide UQPAY documentation as context. The index is available at:

https://developers.uqpay.com/llms.txt

This file follows the llms.txt standard and lists all available documentation pages with descriptions. You can feed it directly into any LLM-based tool to help it discover and retrieve UQPAY documentation.

Troubleshooting

MCP server not connecting

Verify that you have Node.js (v18 or later) installed, as npx is required to run the MCP bridge. Run node --version to check.

Tools not appearing in AI assistant

After adding the MCP configuration, restart your AI tool completely. Some tools require a full restart rather than just a reload.

Search returns no results

Try rephrasing your query with different keywords. The search works best with specific terms like product names (Card Issuance, Global Account), feature names (payout, webhook), or API operation names.

MCP

CLI

SDKs

What you can do with MCP

Prerequisites

Setup

Available tools

Example prompts

llms.txt

Troubleshooting

​What you can do with MCP

​Prerequisites

​Setup

​Available tools

​Example prompts

​llms.txt

​Troubleshooting

What you can do with MCP

Prerequisites

Setup

Available tools

Example prompts

llms.txt

Troubleshooting