> ## Documentation Index
> Fetch the complete documentation index at: https://docs.localpayment.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Servidor MCP

Conecte seu fluxo de trabalho com IA à especificação de API e à documentação ao vivo da Localpayment usando o Model Context Protocol (MCP). Instruções de configuração para Cursor, VS Code, Claude, Windsurf, ChatGPT, Gemini CLI, JetBrains e mais.

O Servidor MCP da Localpayment dá a qualquer ferramenta de IA compatível com MCP acesso direto à especificação de API e à documentação ao vivo. Depois de configurado, seu assistente de IA pode descobrir endpoints, ler esquemas de parâmetros, pesquisar guias e gerar código de integração preciso — baseado na especificação atual, e não em dados de treinamento potencialmente desatualizados.

> [!NOTE]
>
> **Início rápido**: O servidor Localpayment MCP está disponível em `https://docs.localpayment.com/mcp`. É público e não requer autenticação.

***

## O que é o MCP?

O Model Context Protocol (MCP) é um padrão aberto que funciona como uma porta USB para IA — ele oferece aos assistentes de IA uma forma padronizada de se conectar a fontes de dados e ferramentas externas. Em vez de depender de um retrato de treinamento estático e potencialmente desatualizado da API, sua ferramenta de IA consulta a documentação ao vivo da Localpayment em tempo real.

***

## Conectar ao Servidor MCP

Selecione sua ferramenta de IA para obter a configuração:

> [tab] Cursor
>
> [Instalar no Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=localpayment\&config=eyJ1cmwiOiJodHRwczovL2RvY3MubG9jYWxwYXltZW50LmNvbS9tY3AifQ==)
>
> Ou adicione manualmente a `~/.cursor/mcp.json`:
>
> ```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> {
>   "mcpServers": {
>     "localpayment": {
>       "url": "https://docs.localpayment.com/mcp"
>     }
>   }
> }
> ```
>
> Reinicie o Cursor e abra o chat de IA. As ferramentas da Localpayment estarão disponíveis automaticamente.

> [tab] VS Code (Copilot)
>
> [Instalar no VS Code](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22type%22%3A%22http%22%2C%22name%22%3A%22localpayment%22%2C%22url%22%3A%22https%3A%2F%2Fdocs.localpayment.com%2Fmcp%22%7D)
>
> Ou adicione manualmente ao `settings.json` do seu VS Code ou a `.vscode/mcp.json`:
>
> ```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> {
>   "mcp": {
>     "servers": {
>       "localpayment": {
>         "type": "http",
>         "url": "https://docs.localpayment.com/mcp"
>       }
>     }
>   }
> }
> ```
>
> Requer o GitHub Copilot Chat com suporte a MCP habilitado.

> [tab] Claude Desktop
>
> Adicione o seguinte ao seu `claude_desktop_config.json`:
>
> **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
> **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
>
> ```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> {
>   "mcpServers": {
>     "localpayment": {
>       "url": "https://docs.localpayment.com/mcp"
>     }
>   }
> }
> ```
>
> Reinicie o Claude Desktop para aplicar a configuração.

> [tab] Claude Code
>
> Execute o seguinte comando no seu terminal:
>
> ```bash theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> claude mcp add localpayment --url https://docs.localpayment.com/mcp
> ```
>
> > [!NOTE]
> >
> > Esta é a opção de configuração mais rápida — um único comando adiciona o servidor MCP da Localpayment ao seu projeto do Claude Code de forma permanente.
>
> O servidor MCP estará disponível em todas as sessões futuras do Claude Code neste projeto.

> [tab] Windsurf
>
> Adicione o seguinte a `~/.codeium/windsurf/mcp_config.json`:
>
> ```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> {
>   "mcpServers": {
>     "localpayment": {
>       "url": "https://docs.localpayment.com/mcp"
>     }
>   }
> }
> ```
>
> Reinicie o Windsurf para aplicar a configuração.

> [tab] ChatGPT
>
> 1. Abra o **ChatGPT** e acesse **Configurações → Conectores**.
> 2. Selecione **Adicionar conector personalizado**.
> 3. Insira a URL do servidor MCP: `https://docs.localpayment.com/mcp`
> 4. Salve e inicie uma nova conversa.
>
> As ferramentas da Localpayment estarão disponíveis na sua sessão de chat.

> [tab] Gemini CLI
>
> Adicione o seguinte ao arquivo de configuração de MCP do seu Gemini CLI:
>
> ```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> {
>   "mcpServers": {
>     "localpayment": {
>       "url": "https://docs.localpayment.com/mcp"
>     }
>   }
> }
> ```

> [tab] JetBrains
>
> 1. Abra **Configurações → Ferramentas → Assistente de IA → Servidores MCP**.
> 2. Clique em **Adicionar** e insira:
>    * **Nome**: Localpayment
>    * **URL**: `https://docs.localpayment.com/mcp`
> 3. Aplique e reinicie a IDE.

> [tab] OpenHands
>
> [OpenHands](https://github.com/All-Hands-AI/OpenHands) é uma plataforma de desenvolvimento de software com IA de código aberto, com suporte nativo a MCP.
>
> **Pela interface do OpenHands:**
>
> 1. Abra o OpenHands e acesse **Configurações → MCP**.
> 2. Adicione um novo servidor com:
>    * **Transporte**: Streamable HTTP
>    * **URL**: `https://docs.localpayment.com/mcp`
> 3. Salve. As ferramentas da Localpayment ficarão disponíveis para o agente automaticamente.
>
> **Via `config.toml`:**
>
> ```toml theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> [mcp]
> [[mcp.servers]]
> name = "localpayment"
> transport = "streamable_http"
> url = "https://docs.localpayment.com/mcp"
> ```

> [tab] OpenCode
>
> [OpenCode](https://opencode.ai) é um agente de codificação com IA de código aberto para o terminal, com suporte nativo a MCP.
>
> Adicione o seguinte ao seu arquivo de configuração `opencode.jsonc` (raiz do projeto ou `~/.config/opencode/opencode.jsonc`):
>
> ```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> {
>   "$schema": "https://opencode.ai/config.json",
>   "mcp": {
>     "localpayment": {
>       "type": "remote",
>       "url": "https://docs.localpayment.com/mcp",
>       "enabled": true
>     }
>   }
> }
> ```
>
> Depois de adicionadas, as ferramentas MCP da Localpayment ficam automaticamente disponíveis para o LLM junto com as ferramentas integradas. Faça referência a elas nos seus prompts: `use the localpayment tool to...`
>
> > [!NOTE]
> >
> > O OpenCode é de código aberto (MIT) e oferece suporte a Claude, OpenAI, Google e modelos locais. Consulte a [documentação de MCP do OpenCode](https://opencode.ai/docs/mcp-servers/) para ver opções de configuração adicionais, incluindo o gerenciamento de ferramentas por agente.

> [tab] Outro
>
> Qualquer ferramenta compatível com MCP que ofereça suporte a transporte HTTP pode se conectar usando:
>
> ```json theme={"theme":{"light":"github-light-high-contrast","dark":"github-dark-high-contrast"}}
> {
>   "mcpServers": {
>     "localpayment": {
>       "url": "https://docs.localpayment.com/mcp"
>     }
>   }
> }
> ```
>
> Consulte a documentação da sua ferramenta para saber o formato exato de configuração.

***

## Ferramentas disponíveis

Depois de conectado, seu assistente de IA tem acesso às seguintes ferramentas:

| Ferramenta | Descrição | Exemplo de uso |
| :- | :- | :- |
| `list-endpoints` | Lista todos os caminhos da API e seus métodos HTTP com resumos, organizados por caminho | "Quais endpoints estão disponíveis para virtual accounts?" |
| `get-endpoint` | Retorna todos os detalhes de um endpoint específico: parâmetros, corpo da solicitação, esquemas de resposta e segurança | "Mostre-me a especificação completa do endpoint Create Virtual Account" |
| `search-endpoints` | Busca aprofundada em caminhos, operações e esquemas de componentes por palavra-chave — use para descobrir endpoints por capacidade ou modelo de dados | "Encontre todas as operações relacionadas a aliases" |
| `search` | Pesquisa páginas de guias por consulta, retornando uma lista de resultados com ID, título e URL | "Encontre o guia sobre aliases de CVU na Argentina" |
| `fetch` | Recupera o conteúdo completo de uma página do guia pelo ID: use `search` primeiro para obter o ID. | "Obtenha o conteúdo completo da Visão geral de Virtual Accounts" |

> [!NOTE]
>
> A ferramenta `execute-request` não está habilitada no servidor Localpayment MCP. O servidor é **somente leitura**: ele fornece acesso à documentação e às especificações, mas não executa chamadas de API em seu nome. Para executar solicitações reais durante o desenvolvimento, use o [Postman Collection](https://docs.localpayment.com/pt-br/reference/postman-collection.md) ou seu próprio cliente HTTP com credenciais de ambiente de teste.

***

## Verificar sua configuração

Depois de configurado, abra a interface de chat ou de agente da sua ferramenta de IA e use o prompt a seguir para confirmar que o servidor MCP está conectado e obter uma visão geral completa da API da Localpayment:

```
Using the Localpayment MCP tools, explore the full API and give me a 
complete overview of everything available: list all endpoints organized 
by product area (PayIns, PayOuts, Virtual Accounts, Treasury/FX, etc.), 
explain what each major feature does, identify which countries are 
supported, and explain the key integration patterns. I want a full map 
of the API as my starting point before building my integration.
```

Seu assistente de IA invocará as ferramentas MCP (`list-endpoints`, `search`, `fetch`) e retorna um resumo estruturado da documentação Localpayment em tempo real.

> [!NOTE]
>
> A ferramenta `fetch` requer um **ID** de guia, não uma URL. Use primeiro `search` para encontrar o guia e obter seu ID, depois passe esse ID para `fetch` para obter o conteúdo completo. Exemplo: pesquise por "Virtual Accounts Overview" → obtenha o ID `localpayment/virtual-accounts-overview` → use `fetch` com esse ID.

***

## Solução de problemas

> [accordion] O servidor MCP não está conectando
>
> * Verifique se a URL é exatamente `https://docs.localpayment.com/mcp`, sem variações de barra final.
> * Verifique se seu editor ou ferramenta oferece suporte a **transporte HTTP** para MCP (em oposição a apenas stdio). Todas as configurações desta página usam HTTP.
> * Reinicie seu editor depois de salvar o arquivo de configuração.
> * Verifique sua conexão de rede e confirme se você consegue acessar `https://docs.localpayment.com` em um navegador.

> [accordion] O assistente de IA não está usando as ferramentas MCP
>
> * Alguns editores exigem que você habilite explicitamente as ferramentas MCP nas configurações do chat ou no modo agente.
> * No Cursor, certifique-se de estar usando o modo **Agent** (e não o modo **Ask**) para que as chamadas de ferramentas estejam disponíveis.
> * No VS Code com Copilot, verifique se a extensão MCP está instalada e se o servidor aparece como conectado nas configurações.

> [accordion] As ferramentas retornam informações desatualizadas ou inesperadas
>
> * O servidor MCP reflete a versão publicada atual da documentação da Localpayment. Se você acredita que há uma discrepância, entre em contato com [support@localpayment.com](mailto:support@localpayment.com).

***

## Próximos passos

> [card] [Biblioteca de prompts](https://docs.localpayment.com/pt-br/docs/prompt-library.md)
>
> Prompts prontos para uso para criar integrações, depurar erros e gerar testes — organizados por país e caso de uso.

> [card] [Agentes de IA](https://docs.localpayment.com/pt-br/docs/ai-agents.md)
>
> Implante o Localpayment Integrator Agent no framework de IA de sua preferência.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.