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

# Servidor MCP

> Use o ZapMeow dentro do Claude e de outros clientes MCP: sessões, mensagens, grupos e mídia.

O repositório traz um servidor [MCP](https://modelcontextprotocol.io) (`mcp/`, Node 20+, stdio). Ele traduz cada ferramenta numa chamada da API `/api` com a sua chave. Não guarda nada.

## Instalar

```bash theme={null}
cd mcp && npm install
claude mcp add --scope user zapmeow \
  -e ZAPMEOW_URL=https://<seu-zapmeow> \
  -e ZAPMEOW_API_KEY=<sua-chave> \
  -- node /caminho/para/zapmeow/mcp/index.mjs
```

| Variável | Uso |
| - | - |
| `ZAPMEOW_URL` | base do servidor, sem `/api` (padrão `http://127.0.0.1:8080`) |
| `ZAPMEOW_API_KEY` | a mesma chave do header `X-Api-Key` |

## Ferramentas

| Grupo | Ferramentas |
| - | - |
| Servidor e sessões | `zapmeow_server_info`, `zapmeow_sessions_list`, `zapmeow_session_get`, `zapmeow_session_create`, `zapmeow_session_start`, `_restart`, `_stop`, `_logout`, `_delete`, `zapmeow_session_qr` (devolve a imagem), `zapmeow_session_request_code` |
| Envio | `zapmeow_send_text`, `zapmeow_send_media` (url, arquivo local ou base64), `zapmeow_send_reaction`, `zapmeow_typing` |
| Leitura | `zapmeow_chats_overview`, `zapmeow_chat_messages`, `zapmeow_message_get`, `zapmeow_chats_state`, `zapmeow_chat_action`, `zapmeow_sync_progress` |
| Mídia | `zapmeow_media_get`: baixa a mídia de uma mensagem com a sua chave (a `media.url` exige `X-Api-Key` e não abre sozinha) |
| Contatos e etiquetas | `zapmeow_check_exists`, `zapmeow_contacts_list`, `zapmeow_contact_get`, `zapmeow_profile_picture`, `zapmeow_lid_resolve`, `zapmeow_labels_list`, `zapmeow_chat_labels` |
| Grupos | `zapmeow_groups_list`, `_group_get`, `_group_participants`, `_group_create`, `_group_set_description`, `_group_participants_edit`, `_group_invite_code`, `_group_invite_revoke`, `_group_join_info`, `_group_leave` |

As ferramentas de leitura levam a marca `readOnlyHint`. Envio, logout, exclusão e edição de grupo mudam algo de verdade (mandam mensagem a pessoas reais, desvinculam o número): deixe o cliente pedir confirmação.

> [!WARNING]
>
> O MCP usa a chave de API, que alcança todas as sessões do servidor. Não compartilhe o `claude mcp add` com a chave dentro.


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