whatsapp-docs-mcp 1.0.4 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +2 -0
- package/README.md +47 -139
- package/docs/catalogos/sell_products_and_services.md +1 -1
- package/docs/flows/changelog.md +613 -0
- package/docs/flows/gettingstarted/health_insurance.md +537 -0
- package/docs/flows/gettingstarted/personalised_offer.md +495 -0
- package/docs/flows/gettingstarted/pre_approved_loan.md +506 -0
- package/docs/flows/gettingstarted/purchase_intent.md +246 -0
- package/docs/flows/gettingstarted.md +52 -0
- package/docs/flows/guias.md +60 -0
- package/docs/flows/playground.md +135 -0
- package/docs/flows/referencia.md +102 -0
- package/docs/flows/support.md +32 -0
- package/docs/flows.md +98 -0
- package/docs/{mensagens/limites_de_mensagens → messaging_limits}/upcoming_changes.md +1 -1
- package/docs/suporte.md +408 -0
- package/package.json +9 -2
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,20 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# WhatsApp Business API Docs - MCP Server
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[](https://www.npmjs.com/package/whatsapp-docs-mcp)
|
|
5
|
-
[](https://nodejs.org/)
|
|
3
|
+
Servidor MCP (Model Context Protocol) que fornece acesso completo à documentação da WhatsApp Business API para assistentes de IA como Claude e Cursor.
|
|
6
4
|
|
|
7
|
-
|
|
5
|
+
## 🚀 Como Usar
|
|
8
6
|
|
|
9
|
-
|
|
7
|
+
### Configuração MCP (Cursor e Claude Desktop)
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
Tanto o **Cursor** quanto o **Claude Desktop** usam o mesmo método de configuração MCP:
|
|
12
10
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
11
|
+
1. **Edite o arquivo de configuração MCP:**
|
|
12
|
+
- **Cursor**: `~/.cursor/mcp.json` ou via Settings > Features > MCP
|
|
13
|
+
- **Claude Desktop (macOS)**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
14
|
+
- **Claude Desktop (Windows)**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
16
15
|
|
|
17
|
-
|
|
16
|
+
2. **Adicione a configuração do servidor MCP:**
|
|
18
17
|
|
|
19
18
|
```json
|
|
20
19
|
{
|
|
@@ -24,158 +23,67 @@ Add to Claude Desktop config (`~/Library/Application Support/Claude/claude_deskt
|
|
|
24
23
|
"args": ["whatsapp-docs-mcp"],
|
|
25
24
|
"env": {
|
|
26
25
|
"MCP_MODE": "stdio",
|
|
27
|
-
"LOG_LEVEL": "error"
|
|
28
|
-
"DISABLE_CONSOLE_OUTPUT": "true"
|
|
26
|
+
"LOG_LEVEL": "error"
|
|
29
27
|
}
|
|
30
28
|
}
|
|
31
29
|
}
|
|
32
30
|
}
|
|
33
31
|
```
|
|
34
32
|
|
|
35
|
-
**
|
|
36
|
-
|
|
37
|
-
See [MCP_SETUP.md](./MCP_SETUP.md) for detailed setup instructions.
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
# Documentação WhatsApp Business API
|
|
42
|
-
|
|
43
|
-
Esta é a documentação completa da WhatsApp Business API, organizada de forma hierárquica para facilitar o desenvolvimento e o uso por sistemas de IA.
|
|
44
|
-
|
|
45
|
-
## 📚 Estrutura da Documentação
|
|
46
|
-
|
|
47
|
-
A documentação está organizada em seções principais:
|
|
33
|
+
3. **Reinicie o Cursor ou Claude Desktop**
|
|
48
34
|
|
|
49
|
-
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
35
|
+
4. **Pronto!** Agora você pode usar as ferramentas MCP diretamente:
|
|
36
|
+
- `search_documentation` - Buscar na documentação
|
|
37
|
+
- `get_document_by_path` - Obter documento específico
|
|
38
|
+
- `get_endpoint_reference` - Referência de endpoint
|
|
39
|
+
- `get_error_code_info` - Informações sobre códigos de erro
|
|
40
|
+
- `get_quick_reference` - Referência rápida de operações comuns
|
|
55
41
|
|
|
56
|
-
|
|
42
|
+
### Método Alternativo: Usar arquivos diretamente
|
|
57
43
|
|
|
58
|
-
|
|
44
|
+
Se preferir não usar MCP, você pode adicionar os arquivos diretamente no chat:
|
|
59
45
|
|
|
60
|
-
1. **Configuração Inicial**: Veja [Começar](./docs/comecar/get_started.md)
|
|
61
|
-
2. **Primeira Mensagem**: Siga o guia em [Mensagens > Visão Geral](./docs/mensagens/visao_geral/)
|
|
62
|
-
3. **Configurar Webhooks**: [Webhooks > Visão Geral](./docs/webhooks/visao_geral/)
|
|
63
|
-
|
|
64
|
-
### Para Usar com Cursor AI 🤖
|
|
65
|
-
|
|
66
|
-
**⚡ Início Rápido**: Veja [INICIO_RAPIDO.md](./INICIO_RAPIDO.md)
|
|
67
|
-
|
|
68
|
-
**📖 Guias Completos**:
|
|
69
|
-
- [Passo a Passo Detalhado](./PASSO_A_PASSO_CURSOR.md) - Como usar no Cursor
|
|
70
|
-
- [Guia de Contexto](./CURSOR_CONTEXT_GUIDE.md) - Guia completo de uso
|
|
71
|
-
- [Integração em Projetos](./INTEGRACAO_PROJETOS.md) - Como integrar em outros projetos
|
|
72
|
-
- [Usar SEM Copiar Arquivos](./USAR_SEM_COPIAR.md) - Workspace multi-root
|
|
73
|
-
- [Usar com Feature "Docs"](./USAR_COM_DOCS_FEATURE.md) - Servir localmente via HTTP ⭐
|
|
74
|
-
- [Snippets Prontos](./CURSOR_SNIPPETS.md) - Comandos prontos para copiar
|
|
75
|
-
|
|
76
|
-
**Uso Básico no Cursor:**
|
|
77
|
-
|
|
78
|
-
**Método 1: Adicionar arquivos diretamente**
|
|
79
46
|
```
|
|
80
|
-
@AGENTS.md # Índice principal
|
|
81
|
-
@docs/QUICK_REFERENCE.md # Referência rápida
|
|
47
|
+
@AGENTS.md # Índice principal da documentação
|
|
48
|
+
@docs/QUICK_REFERENCE.md # Referência rápida de endpoints
|
|
82
49
|
```
|
|
83
50
|
|
|
84
|
-
|
|
85
|
-
```bash
|
|
86
|
-
# 1. Servir localmente
|
|
87
|
-
npm run serve
|
|
88
|
-
# ou
|
|
89
|
-
./scripts/serve_docs.sh
|
|
90
|
-
|
|
91
|
-
# 2. No Cursor > Docs > Add Doc
|
|
92
|
-
# URL: http://localhost:8000/AGENTS.md
|
|
93
|
-
```
|
|
51
|
+
## 📚 Documentação
|
|
94
52
|
|
|
95
|
-
|
|
53
|
+
A documentação está organizada em `docs/` com os seguintes arquivos principais:
|
|
96
54
|
|
|
97
|
-
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
55
|
+
- **`AGENTS.md`** - Índice principal com links para todas as seções
|
|
56
|
+
- **`docs/QUICK_REFERENCE.md`** - Referência rápida de endpoints e exemplos
|
|
57
|
+
- **`docs/comecar/get_started.md`** - Guia para começar
|
|
58
|
+
- **`docs/mensagens/`** - Documentação sobre mensagens
|
|
59
|
+
- **`docs/webhooks/`** - Webhooks e notificações
|
|
60
|
+
- **`docs/referencia/`** - Referência completa da API
|
|
61
|
+
- **`docs/suporte/`** - Códigos de erro e troubleshooting
|
|
101
62
|
|
|
102
|
-
|
|
63
|
+
Cada pasta contém um arquivo `AGENTS.md` com índice e links para facilitar a navegação.
|
|
103
64
|
|
|
104
|
-
|
|
65
|
+
## 🔧 Instalação Local (Desenvolvimento)
|
|
105
66
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
- Os arquivos `AGENTS.md` fornecem contexto e estrutura
|
|
112
|
-
- Documentos markdown contêm a documentação completa
|
|
113
|
-
- Links relativos facilitam a navegação programática
|
|
114
|
-
|
|
115
|
-
## 🔑 Endpoints Principais
|
|
116
|
-
|
|
117
|
-
### Enviar Mensagens
|
|
118
|
-
- **Texto**: `POST /v23.0/{phone-number-id}/messages`
|
|
119
|
-
- **Mídia**: Ver [Mensagens > Tipos de Mensagens](./docs/mensagens/tipos_de_mensagens/)
|
|
120
|
-
- **Templates**: Ver [Modelos](./docs/modelos/)
|
|
121
|
-
|
|
122
|
-
### Webhooks
|
|
123
|
-
- **Configurar**: Ver [Webhooks > Visão Geral](./docs/webhooks/visao_geral/)
|
|
124
|
-
- **Referência**: Ver [Webhooks > Referência](./docs/webhooks/referencia/)
|
|
125
|
-
|
|
126
|
-
### Gerenciamento
|
|
127
|
-
- **Contas**: Ver [Referência > Conta do WhatsApp Business](./docs/referencia/conta_do_whatsapp_business/)
|
|
128
|
-
- **Números**: Ver [Referência > Telefone do WhatsApp Business](./docs/referencia/telefone_do_whatsapp_business/)
|
|
129
|
-
|
|
130
|
-
## 📝 Casos de Uso Comuns
|
|
131
|
-
|
|
132
|
-
1. **Enviar Mensagem de Texto**: [Mensagens > Texto](./docs/mensagens/tipos_de_mensagens/text_messages.md)
|
|
133
|
-
2. **Enviar Imagem**: [Mensagens > Imagem](./docs/mensagens/tipos_de_mensagens/image_messages.md)
|
|
134
|
-
3. **Configurar Webhook**: [Webhooks > Visão Geral](./docs/webhooks/visao_geral/overview.md)
|
|
135
|
-
4. **Criar Template**: [Modelos > Gerenciamento](./docs/modelos/gerenciamento_de_modelos/)
|
|
136
|
-
5. **Tratar Erros**: [Suporte > Códigos de Erro](./docs/suporte/error_codes.md)
|
|
137
|
-
|
|
138
|
-
## 🛠️ Recursos Adicionais
|
|
67
|
+
```bash
|
|
68
|
+
# Clone o repositório
|
|
69
|
+
git clone https://github.com/yvfl/api-whatsapp-docs.git
|
|
70
|
+
cd api-whatsapp-docs
|
|
139
71
|
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
- **Preços**: [Recado > Preços](./docs/recado/precos/)
|
|
72
|
+
# Instale as dependências
|
|
73
|
+
npm install
|
|
143
74
|
|
|
144
|
-
|
|
75
|
+
# Compile o projeto
|
|
76
|
+
npm run build
|
|
145
77
|
|
|
78
|
+
# Execute os testes
|
|
79
|
+
npm test
|
|
146
80
|
```
|
|
147
|
-
docs/
|
|
148
|
-
├── AGENTS.md # Índice principal
|
|
149
|
-
├── visao_geral/ # Visão geral da plataforma
|
|
150
|
-
├── comecar/ # Guias de início rápido
|
|
151
|
-
├── mensagens/ # Documentação de mensagens
|
|
152
|
-
│ ├── tipos_de_mensagens/ # Tipos específicos
|
|
153
|
-
│ ├── limites_de_mensagens/ # Limites e restrições
|
|
154
|
-
│ └── recursos_adicionais/ # Recursos extras
|
|
155
|
-
├── webhooks/ # Webhooks e notificações
|
|
156
|
-
├── referencia/ # Referência completa da API
|
|
157
|
-
└── suporte/ # Suporte e troubleshooting
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
## 🤖 Para Desenvolvimento com IA
|
|
161
|
-
|
|
162
|
-
Esta documentação foi estruturada para facilitar o uso por sistemas de IA:
|
|
163
|
-
|
|
164
|
-
1. **Estrutura Hierárquica**: Organização clara por funcionalidade
|
|
165
|
-
2. **AGENTS.md**: Cada pasta tem um índice com contexto
|
|
166
|
-
3. **Links Relativos**: Facilita navegação programática
|
|
167
|
-
4. **Documentação Completa**: Todos os endpoints e recursos documentados
|
|
168
|
-
|
|
169
|
-
## 📞 Suporte
|
|
170
81
|
|
|
171
|
-
- **Códigos de Erro**: [Suporte > Códigos de Erro](./docs/suporte/error_codes.md)
|
|
172
|
-
- **Status da API**: [Suporte > API Status Page](./docs/suporte/api_status_page.md)
|
|
173
|
-
- **Testes**: [Suporte > Load Testing](./docs/suporte/load_testing.md)
|
|
174
82
|
|
|
175
|
-
##
|
|
83
|
+
## 🤝 Contribuindo
|
|
176
84
|
|
|
177
|
-
|
|
85
|
+
Contribuições são bem-vindas! Por favor, abra uma issue ou pull request.
|
|
178
86
|
|
|
179
|
-
|
|
87
|
+
## 📄 Licença
|
|
180
88
|
|
|
181
|
-
|
|
89
|
+
MIT License
|