> For the complete documentation index, see [llms.txt](https://docs.hyperswitch.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperswitch.io/about-hyperswitch/ai-resources/setup-mcp-server.md).

# Setup MCP Server

{% hint style="danger" %}
This MCP server is only meant for product exploration while using sandbox environment.\
**DO NOT USE Juspay Hyperswitch API Key from the PRODUCTION ENVIRONMENT.**
{% endhint %}

**Prerequisites**: Ensure you have an MCP client installed (Cursor, Claude Desktop, Cline, etc.)

**MCP URL:** `https://api-reference.hyperswitch.io/mcp`

### Step 1: Configure the Hyperswitch-Mintlify MCP server

Hyperswitch's Mintlify MCP server lets your AI client search Hyperswitch docs and safely explore Sandbox APIs as tools (e.g., create a payment and get a 3DS/redirect URL).

### Recommended: Claude Code

Add it via CLI:

```bash
claude mcp add --transport http mint-hyperswitch https://api-reference.hyperswitch.io/mcp
```

On successfully adding this, you should see this output in CLI:

![Adding MCP server](/files/32A8SlBxN0u3IZ7TpghU)

Run `claude` and verify if MCP was configured properly using `/mcp`. You should see an output similar to:

![Verifying the MCP server](/files/7zC8XIGLxAY4rcUl46mC)

### For configuring other MCP clients (Cursor / Claude Desktop / etc.)

Follow Mintlify's [client-specific setup guide](https://www.mintlify.com/docs/ai/model-context-protocol?_gl=1*1m5cmfd*_gcl_au*MTY1NjU2NDE1LjE3NjY0NzY1MzE.#example:-connect-to-the-mintlify-mcp-server) using the same MCP: `https://api-reference.hyperswitch.io/mcp`

### Step 2: Make your first payment

Paste below prompt in your AI client after replacing with your sandbox `API_KEY`:

```bash
Make a 100 EUR payment via Hyperswitch V1 in sandbox.
Sandbox API key: <YOUR_SANDBOX_API_KEY>
```

### **Output:**

You can head on to payment section in [Hyperswitch Control Center](https://app.hyperswitch.io/dashboard/payments) and verify the payment with the time stamp and status as `REQUIRES_CUSTOMER_ACTION` (depending on the flow you selected - 3DS vs No3DS).

{% hint style="warning" %}
Responses from AI tools can be incorrect, use with caution.\
and reach out to us on [slack](https://inviter.co/hyperswitch-slack) for any questions or further support.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.hyperswitch.io/about-hyperswitch/ai-resources/setup-mcp-server.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.