Skip to main content
Z

Z-API

@codespar/mcp-z-api · v0.2.2

🇧🇷 BrasilMensageriaAuth · API Keylive27 ferramentas2 variáveis de ambiente

WhatsApp Business API: mensagens, mídia, templates e webhooks de entrega. Seu agente envia recibos, confirmações e respostas de suporte.

Comece · grátisVer docs

MIT · roda localmente com as suas credenciais

Variáveis de ambiente, nomes e descrições das ferramentas vêm do pacote npm e ficam em inglês.

Limitações

  • O manifesto do pacote não declara 1 das 2 variáveis que o código lê.
  • Chamadas hospedadas com chave de teste não estão disponíveis: o provedor não tem ambiente de teste.
Pacote
@codespar/mcp-z-api
Versão
0.2.2
dist-tag npm
latest
Categoria
Mensageria
Auth
API Key
País
🇧🇷 Brasil
Licença
MIT
Transporte
stdio · streamable-http

Início rápido

Instale, configure as credenciais, faça a primeira chamada.

Escolha seu cliente. O servidor roda localmente via stdio, com as suas credenciais.

Adicione o servidor ao seu clienteUma entrada de configuração. Sem build, sem SDK.
Defina as variáveis de ambiente2 variáveis lidas pelo código deste servidor, listadas abaixo.
Reinicie e faça a primeira chamadaO agente pode chamar qualquer uma das 27 ferramentas. Comece por send_text.
terminal
# Claude Code claude mcp add z-api -e ZAPI_INSTANCE_ID=… -e ZAPI_TOKEN=… -- npx -y @codespar/mcp-z-api@0.2.2 # then: /mcp to confirm the server is connected
Variáveis de ambiente2 variáveis
ZAPI_INSTANCE_IDLida pelo código; o manifesto do pacote não a declara.
ZAPI_TOKENAPI key for z-apiobrigatóriasegredo

Nomes lidos do código do pacote (@codespar/mcp-z-api@0.2.2). Descrições e marcações vêm do manifesto dele. Auto-hospedado, você guarda as credenciais.

Primeira chamada demosend_text

"Send a text message via WhatsApp"

tools/callsend_textresultado devolvido

Ferramentas

O que o seu agente pode chamar.

27 ferramentas, como o tools/list do pacote as devolve.

send_text

Send a text message via WhatsApp

send_image

Send an image message via WhatsApp

send_document

Send a document via WhatsApp

send_audio

Send an audio message via WhatsApp

get_contacts

Get all WhatsApp contacts

check_number

Check if a phone number has WhatsApp

get_profile_picture

Get profile picture URL for a phone number

get_messages

Get messages for a phone number

send_button_list

Send a button list message via WhatsApp

get_status

Get WhatsApp instance connection status

create_group

Create a WhatsApp group

get_group_metadata

Get group metadata and participants

Nomes e descrições vêm do tools/list do pacote (@codespar/mcp-z-api@0.2.2). Um tipo (leitura, escrita, exclusão) só aparece quando o pacote anota suas ferramentas ou cada ferramenta foi verificada uma a uma; nenhum dos dois existe ainda para este servidor.

Compatibilidade

MCP é um protocolo. Qualquer cliente que o fale pode montar este servidor.

O codespar_discover lista as ferramentas deste servidor, mas um projeto com chave de teste não consegue chamá-las: o provedor não tem ambiente de teste, então o runtime recusa chamadas em modo de teste.

Protocolo

Qualquer cliente MCP

stdio · streamable-http

Perguntas

Antes de instalar.

Como instalo o servidor MCP Z-API?

Rode npx -y @codespar/mcp-z-api@0.2.2 e adicione o bloco de configuração acima ao seu cliente MCP: Claude Code, Cursor, Claude Desktop, VS Code ou qualquer cliente compatível. Sem build, sem SDK.

O que meu agente pode fazer com Z-API?

Z-API expõe 27 ferramentas de mensageria. Seu agente as chama diretamente; a lista completa está acima.

Como Z-API autentica, e como as credenciais são guardadas?

Z-API usa API Key. Auto-hospedado, você guarda as credenciais: o servidor as lê das variáveis de ambiente.

Como Z-API lida com mudanças na API do provedor?

Cada servidor tem versão própria no npm. O comando desta página fixa a 0.2.2, a versão cujas ferramentas estão listadas aqui; seu agente segue nela até você trocar a versão.

Z-API é open source? Como reporto um bug?

Sim. Z-API tem licença MIT e está publicado no npm como @codespar/mcp-z-api, com o código no GitHub (link no painel Detalhes). Reporte problemas no repositório do pacote; problemas de segurança vão para security@codespar.dev, e respondemos em até 24 horas.

Comece em segundos.

Adicione a configuração acima, defina as variáveis, e seu agente chama as ferramentas.

Comece em segundos demo
Adicione o servidor ao seu cliente com a configuração acima.
Defina as variáveis de ambiente listadas acima.
Peça ao seu agente a primeira chamada.
Z-API — MCP server · 27 tools | CodeSpar