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

# MCP Server (IA)

Use a documentação da NinePay com assistentes de IA

# Use a documentação da NinePay com assistentes de IA

O MCP Server da NinePay deixa assistentes de IA como Claude, ChatGPT, Cursor e VS Code consultarem esta documentação direto, com as informações sempre atualizadas: endpoints, parâmetros, exemplos e guias.

Com ele, o assistente responde perguntas sobre a integração e gera código com base na documentação oficial, sem você precisar copiar e colar páginas.

> 📘 Só documentação
>
> O MCP Server é público e só lê a documentação. Ele não acessa a sua conta, não usa a sua chave de API e não faz chamadas à API da NinePay.

## Conecte seu assistente ao MCP Server

O endereço do MCP Server é:

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

### O que o assistente pode consultar

| Ferramenta | Para que serve |
|---|---|
| `list-specs` | Lista as especificações OpenAPI disponíveis |
| `list-endpoints` | Lista todos os endpoints da API |
| `search-endpoints` | Busca endpoints por caminho, nome, parâmetro ou campo |
| `get-endpoint` | Traz os detalhes de um endpoint: parâmetros, corpo, respostas e exemplos |
| `search` | Busca nos guias e na referência |
| `fetch` | Lê uma página da documentação em Markdown |

## Configure o MCP Server

Em qualquer página da documentação, o menu ao lado de **Copiar página** tem atalhos para instalar no Cursor e no VS Code e para copiar a configuração.

### Cursor

Adicione ao arquivo `~/.cursor/mcp.json`:

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

### VS Code

Adicione ao arquivo `.vscode/mcp.json` do projeto:

```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 e outros

Adicione um conector MCP remoto com a URL `https://docs.ninepay.com.br/mcp`. O caminho no menu muda conforme o aplicativo: consulte a documentação dele.

## Teste a configuração

Depois de conectar, pergunte ao assistente algo como:

- "Como criar uma assinatura recorrente na NinePay?"
- "Quais campos são obrigatórios para criar um pagamento?"
- "Mostre um exemplo em Node.js para cobrar no PIX no sandbox."

Se a resposta citar endpoints e guias da NinePay, o MCP Server está funcionando.

## Consulte o arquivo LLMs.txt

Para assistentes que não usam MCP, a documentação também está disponível em arquivos de texto pensados para IA:

- [`/llms.txt`](/llms.txt): índice com todas as páginas.
- [`/llms-full.txt`](/llms-full.txt): toda a documentação em um arquivo só.

Toda página também tem uma versão em Markdown: troque o fim do endereço por `.md`.

## Reporte informações incorretas

Assistentes de IA podem errar. Se encontrar uma resposta incorreta baseada nesta documentação, avise a nossa equipe em [ti@ninepay.com.br](mailto:ti@ninepay.com.br).

## Próximos passos

- [Autenticação](/docs/autenticacao)
- [Ambiente de testes](/docs/sandbox)
- [Collections Postman e Insomnia](/docs/collections)