# Claude Code Setup for Finix MCP

![Claude Docs](/assets/claude-logo.532a039d38f6d7f7383a8280a04696c0fe40ab4c554fb95f6fd933f7c2952d49.fec90461.avif)

This guide walks you through setting up Claude Code with the Finix MCP server. After setup, you can ask Claude questions about Finix APIs and get accurate answers from our documentation.

## Prerequisites

Before you begin, make sure you have:

- **Claude Code installed** - Anthropic's CLI tool for AI-assisted development
- **Internet connection** - Required to reach `docs.finix.com`


### Installing Claude Code

If you don't have Claude Code installed yet:


```bash Install Claude Code
npm install -g @anthropic-ai/claude-code
```

Or with Homebrew on macOS:


```bash Install with Homebrew
brew install claude-code
```

For detailed installation instructions, see [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-code).

## Quick Setup

Add the Finix MCP server with a single command:


```bash Add Finix MCP Server
claude mcp add finix-redocly-mcp https://docs.finix.com/mcp --transport http
```

Claude Code can now access Finix documentation.

> **Note:** The MCP server's `search` tool returns results from both the API Reference and Guides. However, the detailed retrieval tools (`get-endpoint-info`, `get-endpoints`, `get-full-spec-document`) only work with the API Reference. To get the full content of a guide page, Claude can fetch the markdown version of any guide using the `.md` URL pattern (see [Enhancing Guide Access](#enhancing-guide-access) below).


## Enhancing Guide Access

The MCP server can search guides but doesn't have a dedicated tool to retrieve their full content. To give Claude full access to both API docs and guides, add the following to your project's `CLAUDE.md` file or system prompt:


```markdown
## Finix Documentation Access

When answering questions about Finix:

1. Use the Finix MCP server tools (`search`, `get-endpoint-info`, `get-endpoints`) to find relevant API reference content.
2. For guide/tutorial content: after using the MCP `search` tool to find relevant guide pages, fetch the full content by appending `.md` to the guide URL. For example:
   - `https://docs.finix.com/guides/getting-started/developer-quickstart.md`
   - `https://docs.finix.com/guides/online-payments/payment-tokenization/tokenization-forms.md`
   - `https://docs.finix.com/guides/payouts/adding-funds.md`
3. Always check both API Reference and Guides for a complete answer.
```

This instruction tells Claude to combine the MCP server tools (for API reference) with direct markdown fetching (for guides), giving it full access to all Finix documentation.

## Verify the Connection

After adding the MCP server, verify it's working:

### Check MCP Status


```bash List MCP Servers
claude mcp list
```

You should see `finix-redocly-mcp` in the list of configured servers.

### Test a Query

Start a Claude Code session and ask a question about Finix:


```bash Start Claude Code
claude
```

**API Reference test:**

Then try a test prompt:

> "What authentication method does the Finix API use?"


If Claude responds with specific details about Finix API authentication (Basic Auth with API credentials), the connection is working.

**Guide access test:**

> "How do I onboard a seller on Finix?"


If Claude responds with details from the seller onboarding guide (not just API endpoint info), guide access is working correctly.

## Configuration Options

### Project-Level Configuration

To add the Finix MCP server only to a specific project, navigate to your project directory first:


```bash Project-Level Setup
cd /path/to/your/project
claude mcp add finix-redocly-mcp https://docs.finix.com/mcp --transport http --scope project
```

This creates a `.claude/mcp.json` file in your project, so the MCP server is only available when working in that directory.

### Global Configuration

To make the Finix MCP server available in all your projects (default behavior):


```bash Global Setup
claude mcp add finix-redocly-mcp https://docs.finix.com/mcp --transport http --scope user
```

### Manual Configuration

You can also manually edit your Claude configuration file.

**Location**:

- macOS/Linux: `~/.claude.json`
- Windows: `%USERPROFILE%\.claude.json`


Add the Finix MCP server to the `mcpServers` section:


```json ~/.claude.json
{
    "mcpServers": {
        "finix-redocly-mcp": {
            "type": "http",
            "url": "https://docs.finix.com/mcp"
        }
    }
}
```

After editing, restart Claude Code for changes to take effect.

## Using Finix MCP

Once configured, Claude automatically uses the MCP server when you ask Finix-related questions.

### Example Prompts

**API Questions**:

> "What fields are required to create a Transfer?"


> "How do I tokenize a card with Finix.js?"


> "What's the difference between a Transfer and an Authorization?"


**Integration Help**:

> "Show me an example of processing a refund"


> "How do I set up webhooks for payment status updates?"


> "What are the steps to onboard a seller?"


**Troubleshooting**:

> "What does error code 402 mean?"


> "Why would a Transfer be in PENDING state?"


> "How do I handle declined payments?"


### Best Practices

For the best results:

1. **Be specific** - "How do I create a card Authorization?" is better than "How do payments work?"
2. **Reference API resources** - Use terms like "Transfer", "Authorization", "Identity", "Merchant" when relevant
3. **Ask for examples** - "Show me an example of..." prompts Claude to pull code samples from documentation
4. **Mention the environment** - Specify "Sandbox" or "Production" if it matters for your question


## Troubleshooting

### MCP Server Not Found

If `claude mcp list` doesn't show `finix-redocly-mcp`:

1. Re-run the add command:

```bash
claude mcp add finix-redocly-mcp https://docs.finix.com/mcp --transport http
```
2. Check your configuration file exists and is valid JSON


### Connection Errors

If Claude reports connection issues:

1. **Check internet connection** - Verify you can reach `docs.finix.com` in a browser
2. **Check for firewall/proxy issues** - Corporate networks may block MCP connections
3. **Try removing and re-adding**:

```bash Reset Connection
claude mcp remove finix-redocly-mcp
claude mcp add finix-redocly-mcp https://docs.finix.com/mcp --transport http
```


### Claude Not Using Finix Documentation

If Claude seems to be guessing instead of searching documentation:

1. **Be explicit** - Try "Search the Finix documentation for..." in your prompt
2. **Check MCP is enabled** - Run `claude mcp list` to verify the server is configured
3. **Restart Claude Code** - Sometimes a fresh session helps


### Claude Only Returning API Reference (No Guide Content)

If Claude answers with only API endpoint details and misses relevant guide content:

1. **Add the `CLAUDE.md` instructions** - See the [Enhancing Guide Access](#enhancing-guide-access) section above to instruct Claude to fetch guide markdown pages
2. **Ask explicitly** - Try "Check the Finix guides for how to..." to prompt Claude to search for guide content


### Outdated Information

The MCP server queries Finix's published documentation. If you notice outdated information:

1. Check [docs.finix.com](https://docs.finix.com) directly to verify current documentation
2. The MCP server reflects published docs, which are updated regularly


## Removing the MCP Server

To disconnect Claude Code from Finix documentation:


```bash Remove Finix MCP Server
claude mcp remove finix-redocly-mcp
```

## Next Steps

MCP Server Overview
Learn more about what the Finix MCP server can do.

Developer Quickstart
Start building your Finix integration.

API Reference
Explore the complete Finix API documentation.