Cleared

npx add-mcp 'https://api.clearedpay.xyz/mcp'

Integração MCP

O servidor MCP Cleared expõe doze ferramentas para fluxos de trabalho de faturas e clientes. Ele está disponível no repositório privado Cleared, não atualmente no registro público npm. Entre em contato com a equipe para obter acesso ao repositório. É necessário um cliente que suporte servidores MCP stdio locais.

Configuração

1. Obtenha acesso ao repositório, instale o Bun e execute bun install a partir da raiz do checkout.
2. Conclua a configuração da organização e crie credenciais de API. Salve tanto o ID da chave clr_pk_ quanto o segredo clr_sk_.
3. Para gravações de faturas, ative o assinante do servidor nas configurações do proprietário. Prepare clientes completos no painel ou na API REST.
4. Adicione uma configuração MCP local. Use o armazenamento de segredos do seu cliente, se disponível; proteja qualquer arquivo de configuração que contenha credenciais.

{
  "mcpServers": {
    "cleared": {
      "command": "bun",
      "args": ["run", "/absolute/path/to/cleared/packages/mcp/src/bin/cleared-mcp.ts"],
      "env": {
        "CLEARED_API_KEY": "clr_sk_REPLACE_WITH_YOUR_SECRET",
        "CLEARED_KEY_ID": "clr_pk_REPLACE_WITH_YOUR_KEY_ID",
        "CLEARED_API_URL": "https://api.clearedpay.xyz",
        "CLEARED_CHAIN": "base-sepolia"
      }
    }
  }
}

Substitua o caminho do checkout e os espaços reservados. O comando de entrada de origem evita a necessidade de saída MCP pré-construída. Garanta que o cliente MCP consiga encontrar o Bun, ou forneça o caminho absoluto do executável. Não cole segredos em um prompt de agente.

CLEARED_API_URL tem como padrão https://api.clearedpay.xyz; CLEARED_CHAIN aceita base (padrão) ou base-sepolia. Flags equivalentes são --api-key=..., --key-id=..., --api-url=... e --chain=...; flags substituem valores de ambiente. Prefira valores de ambiente gerenciados por segredos em vez de segredos em linha de comando.

A opção de cadeia não substitui a rede de API do estúdio. Use uma organização Base Sepolia e suas credenciais para o exemplo. A configuração MCP afeta a apresentação, como rótulos de rede/URLs de explorador, enquanto chamadas de API autenticadas derivam o contexto da cadeia do estúdio. Alinhe ambas as configurações para evitar rótulos enganosos.

Primeira leitura

Invoque list_invoices com { "limit": 5 } ou get_dashboard com {}. Ferramentas de leitura não criam faturas. Inspecione erros e limitações conhecidas antes de confiar nos totais resumidos.

O servidor assina solicitações HTTP usando HMAC; ele não transforma a chave de API em uma carteira de proprietário. send_invoice cria uma fatura, e cancel_invoice realiza um cancelamento on-chain. Nenhuma ferramenta paga uma fatura ou retira fundos. O e-mail é opcional em send_invoice.

Cobertura de ferramentas e limites

Consulte todos os parâmetros de ferramentas. Ferramentas de fatura aceitam IDs numéricos globais ou números de fatura de comerciante formatados, resolvidos dentro do seu estúdio e ano de emissão. list_invoices aceita até 50 resultados por página e retorna page.next_cursor para continuação da navegação com os mesmos filtros. Limites e datas inválidos são rejeitados.

create_customer e update_customer suportam endereços de cobrança e dados de registro de entidades. Forneça nome, e-mail, endereço completo e, para entidades, registration_number. Consulte a referência de ferramentas para exemplos de criação e comportamento de nova tentativa de fatura.

Use apenas integrações confiáveis com credenciais: a aplicação de escopo granular está incompleta. Uma chave rotulada como leitura não é uma sandbox de toda a API. Consulte agentes para desativação, revogação e visibilidade de atividades.