---
agentTools:
  projectIndex: https://docs.ninepay.com.br/llms.txt
  projectSearch: https://docs.ninepay.com.br/agentSearch?query=term1%20term2
---

# MCP Server (AI)

Use the NinePay documentation with AI assistants

# Use the NinePay documentation with AI assistants

The NinePay MCP Server lets AI assistants such as Claude, ChatGPT, Cursor and VS Code query this documentation directly, always up to date: endpoints, parameters, examples and guides.

With it, your assistant answers integration questions and writes code based on the official documentation, without you copying and pasting pages.

> 📘 Documentation only
>
> The MCP Server is public and read-only. It doesn't access your account, doesn't use your API key and doesn't call the NinePay API.

## Connect your assistant to the MCP Server

The MCP Server address is:

```text URL
https://docs.ninepay.com.br/mcp
```

### What the assistant can query

| Tool | What it does |
|---|---|
| `list-specs` | Lists the available OpenAPI specs |
| `list-endpoints` | Lists every API endpoint |
| `search-endpoints` | Searches endpoints by path, name, parameter or field |
| `get-endpoint` | Returns an endpoint's details: parameters, body, responses and examples |
| `search` | Searches the guides and the reference |
| `fetch` | Reads a documentation page as Markdown |

## Configure the MCP Server

On any documentation page, the menu next to **Copiar página** has shortcuts to install in Cursor and VS Code and to copy the configuration.

### Cursor

Add to `~/.cursor/mcp.json`:

```json mcp.json
{
  "mcpServers": {
    "ninepay-docs-mcp": {
      "url": "https://docs.ninepay.com.br/mcp"
    }
  }
}
```

### VS Code

Add to the project's `.vscode/mcp.json`:

```json .vscode/mcp.json
{
  "servers": {
    "ninepay-docs-mcp": {
      "type": "http",
      "url": "https://docs.ninepay.com.br/mcp"
    }
  }
}
```

### Claude Code

```bash Terminal
claude mcp add --transport http ninepay-docs-mcp https://docs.ninepay.com.br/mcp
```

### Claude Desktop, ChatGPT and others

Add a remote MCP connector with the URL `https://docs.ninepay.com.br/mcp`. The menu path depends on the app: check its documentation.

## Test the configuration

Once connected, ask your assistant something like:

- "How do I create a recurring subscription on NinePay?"
- "Which fields are required to create a payment?"
- "Show a Node.js example to charge with PIX in the sandbox."

If the answer cites NinePay endpoints and guides, the MCP Server is working.

## Use the LLMs.txt file

For assistants that don't use MCP, the documentation is also available as text files made for AI:

- [`/llms.txt`](/llms.txt): an index of every page.
- [`/llms-full.txt`](/llms-full.txt): the whole documentation in a single file.

Every page also has a Markdown version: replace the end of its address with `.md`.

## Report incorrect information

AI assistants can make mistakes. If you find a wrong answer based on this documentation, let our team know at [ti@ninepay.com.br](mailto:ti@ninepay.com.br).

## Next steps

- [Authentication](/docs/authentication)
- [Sandbox](/docs/sandbox-en)
- [Postman and Insomnia collections](/docs/collections-en)