@lionchat/mcp-server 0.4.2 → 0.4.3
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/dist/docs/instructions.md +11 -6
- package/dist/docs/resources/api-conventions.md +34 -35
- package/dist/docs/resources/troubleshooting.md +17 -23
- package/endpoints.json +12386 -7093
- package/package.json +1 -1
|
@@ -78,18 +78,23 @@ Account (conta/empresa)
|
|
|
78
78
|
- `display_id`: número visível na UI da conversa (use este pra falar com humanos)
|
|
79
79
|
- `source_id`: ID externo da plataforma origem (ex: `wamid.xxx` do WhatsApp)
|
|
80
80
|
|
|
81
|
-
### Body wrapper —
|
|
81
|
+
### Body wrapper — use raiz por padrão
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
O Rails tem `wrap_parameters: [:json]` global. Body JSON raiz é auto-wrapped no nome do recurso, então ambas as formas funcionam na maioria dos endpoints:
|
|
84
84
|
|
|
85
85
|
```json
|
|
86
86
|
PUT /api/v1/accounts/43/kanban_config
|
|
87
|
-
{ "
|
|
88
|
-
|
|
89
|
-
{ "win_reasons": [...] } ❌ 500
|
|
87
|
+
{ "win_reasons": [...] } ✅ raiz (recomendado)
|
|
88
|
+
{ "kanban_config": { "win_reasons": [...] } } ✅ explícito (também OK)
|
|
90
89
|
```
|
|
91
90
|
|
|
92
|
-
|
|
91
|
+
**Exceção importante — `/contacts` SÓ aceita raiz.** Com wrapper, o `name`/`email`/`phone_number` somem silenciosamente e o contato é criado vazio:
|
|
92
|
+
|
|
93
|
+
```json
|
|
94
|
+
POST /api/v1/accounts/43/contacts
|
|
95
|
+
{ "name": "Fulano", "phone_number": "+5511..." } ✅
|
|
96
|
+
{ "contact": { "name": "Fulano" } } ⚠️ cria contato com name vazio
|
|
97
|
+
```
|
|
93
98
|
|
|
94
99
|
Detalhes completos em `lionchat://docs/api-conventions` → "Wrapper de body".
|
|
95
100
|
|
|
@@ -19,62 +19,61 @@ Pra você via MCP: tudo já tá resolvido. O servidor MCP injeta o token correto
|
|
|
19
19
|
|
|
20
20
|
Tokens são **por usuário**, não por conta. O mesmo token funciona em qualquer conta que o usuário tem acesso. O scoping por conta acontece via `account_id` no path.
|
|
21
21
|
|
|
22
|
-
## Wrapper de body —
|
|
22
|
+
## Wrapper de body — como o Rails interpreta
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
O projeto roda com `wrap_parameters format: [:json]` no Rails (config global). Na prática:
|
|
25
25
|
|
|
26
|
-
|
|
26
|
+
- Bodies JSON raiz são **auto-wrapped** pelo Rails no nome do recurso (derivado do controller).
|
|
27
|
+
- Mandar `{"enabled": true}` em `PUT /kanban_config` é equivalente a mandar `{"kanban_config": {"enabled": true}}`.
|
|
28
|
+
- Ambas as formas funcionam na maioria dos endpoints. Não existe "HTTP 500 silencioso por falta de wrapper" — esse claim era impreciso.
|
|
29
|
+
|
|
30
|
+
### Padrão recomendado
|
|
31
|
+
|
|
32
|
+
Use **body raiz** (sem wrapper). É mais curto, funciona em todos os endpoints listados abaixo, e evita a pegadinha do `/contacts`.
|
|
27
33
|
|
|
28
34
|
```http
|
|
29
35
|
PUT /api/v1/accounts/43/kanban_config
|
|
30
36
|
Content-Type: application/json
|
|
31
37
|
|
|
32
|
-
{
|
|
33
|
-
"kanban_config": {
|
|
34
|
-
"win_reasons": [...],
|
|
35
|
-
"enabled": true
|
|
36
|
-
}
|
|
37
|
-
}
|
|
38
|
+
{ "win_reasons": [{"id": "wr-1", "title": "Preço competitivo"}] }
|
|
38
39
|
```
|
|
39
40
|
|
|
40
|
-
|
|
41
|
+
### Comportamento por endpoint (validado empiricamente)
|
|
41
42
|
|
|
42
|
-
|
|
43
|
+
| Endpoint | Raiz | Com wrapper | Observação |
|
|
44
|
+
|---|---|---|---|
|
|
45
|
+
| `POST/PUT /kanban_config` | ✅ | ✅ | qualquer um |
|
|
46
|
+
| `POST/PATCH /funnels` | ✅ | ✅ | qualquer um |
|
|
47
|
+
| `POST/PUT /kanban_items` | ✅ | ✅ | controller usa `require(:kanban_item)` mas auto-wrap resolve |
|
|
48
|
+
| `POST/PATCH /labels` | ✅ | ✅ | qualquer um |
|
|
49
|
+
| `POST/PATCH /custom_attribute_definitions` | ✅ | ✅ | qualquer um |
|
|
50
|
+
| `POST/PATCH /contacts` | ✅ | ⚠️ **drop silencioso** | Controller usa `params.permit(...)` na raiz sem `require(:contact)`. Com wrapper, o auto-wrap não duplica e os campos do body raiz ficam ausentes — o contato é criado com `name` vazio. **USE RAIZ.** |
|
|
51
|
+
| `POST/PATCH /conversations` | ✅ | varia | conversa aceita raiz |
|
|
52
|
+
| `POST /captain/copilot_threads` | ✅ | n/a | só raiz (`message`, `assistant_id`, `conversation_id`) |
|
|
53
|
+
| `POST /voip/settings/create_child_account` | ✅ | n/a | só raiz (`nome`, `login`, `senha`) |
|
|
43
54
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
| `POST/PATCH /funnels` | `funnel: {...}` |
|
|
48
|
-
| `POST/PUT /kanban_items` | `kanban_item: {...}` |
|
|
49
|
-
| `POST/PATCH /contacts` | `contact: {...}` |
|
|
50
|
-
| `POST/PATCH /conversations` | `conversation: {...}` ou direto (varia) |
|
|
51
|
-
| `POST/PATCH /custom_attribute_definitions` | sem wrapper (params raiz) |
|
|
52
|
-
| `POST/PATCH /labels` | sem wrapper |
|
|
53
|
-
| `POST /captain/copilot_threads` | sem wrapper (params raiz: `message`, `assistant_id`) |
|
|
54
|
-
| `POST /voip/settings/create_child_account` | sem wrapper (raiz: `nome`, `login`, `senha`) |
|
|
55
|
+
### Quando WRAPPER é obrigatório
|
|
56
|
+
|
|
57
|
+
Praticamente nunca — exceto se você está testando legacy/curl e quer ser explícito. As tools do MCP geram params com nome `recurso.campo` (ex: `kanban_config.win_reasons`) só pra organizar a UI; no body final qualquer formato roda.
|
|
55
58
|
|
|
56
|
-
###
|
|
59
|
+
### Listas substituem, não fazem merge
|
|
57
60
|
|
|
58
|
-
|
|
59
|
-
2. Params nomeados sem ponto (`message`, `phone`, `title`) ficam direto no body raiz.
|
|
60
|
-
3. Em caso de dúvida: tentar **com wrapper primeiro** (mais comum). Se 500, tentar sem.
|
|
61
|
+
`win_reasons`, `loss_reasons`, `stages`, `linked_conversations`, etc. — quando você manda a lista, ela **substitui** a anterior por inteiro. Pra preservar, leia com GET primeiro e mande a lista completa.
|
|
61
62
|
|
|
62
|
-
###
|
|
63
|
+
### Estrutura interna das listas
|
|
63
64
|
|
|
64
|
-
`
|
|
65
|
+
`win_reasons` / `loss_reasons` aceitam array de **objetos** `{id, title}`, NÃO strings:
|
|
65
66
|
|
|
66
67
|
```json
|
|
67
68
|
{
|
|
68
|
-
"
|
|
69
|
-
"
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
]
|
|
73
|
-
}
|
|
69
|
+
"win_reasons": [
|
|
70
|
+
{"id": "wr-1", "title": "Preço competitivo"},
|
|
71
|
+
{"id": "wr-2", "title": "Indicação forte"}
|
|
72
|
+
]
|
|
74
73
|
}
|
|
75
74
|
```
|
|
76
75
|
|
|
77
|
-
|
|
76
|
+
Strings simples (`"win_reasons": ["motivo"]`) causam erro de serialização.
|
|
78
77
|
|
|
79
78
|
## Restrições de formato em campos comuns
|
|
80
79
|
|
|
@@ -75,36 +75,30 @@ NÃO retry imediato — só piora.
|
|
|
75
75
|
### 500 Internal Server Error
|
|
76
76
|
Erro do servidor LionChat.
|
|
77
77
|
|
|
78
|
-
**
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
{"win_reasons": [...]} // ❌ 500 silencioso
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
Rails levanta `ActionController::ParameterMissing` que vira 500 sem mensagem útil. A request precisa ser:
|
|
86
|
-
|
|
87
|
-
```http
|
|
88
|
-
PUT /api/v1/accounts/43/kanban_config
|
|
89
|
-
{"kanban_config": {"win_reasons": [...]}} // ✅
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
Veja `api-conventions.md → Wrapper de body` pra tabela completa de quais endpoints exigem wrapper.
|
|
93
|
-
|
|
94
|
-
**Outras causas:**
|
|
95
|
-
- Estrutura do array errada (ex: `win_reasons: ["str"]` em vez de `[{id, title}]`)
|
|
96
|
-
- Validação de modelo falha (cheque se o controller tem `validate :*` que rejeita o input)
|
|
78
|
+
**Causas comuns:**
|
|
79
|
+
- Estrutura interna de lista errada (ex: `win_reasons: ["str"]` em vez de `[{id, title}]`)
|
|
80
|
+
- Tipos errados em campos (string onde espera int, hash onde espera array, etc)
|
|
81
|
+
- Validação de modelo lança exceção não tratada
|
|
97
82
|
- Bug genuíno do servidor
|
|
98
83
|
|
|
99
84
|
**Ação:**
|
|
100
|
-
-
|
|
101
|
-
-
|
|
85
|
+
- Revisar tipos e estrutura do payload contra `api-conventions.md` e `data-model.md`
|
|
86
|
+
- Retry 1x após 2-5 segundos
|
|
102
87
|
- Se persiste: reportar pro usuário com timestamp/request ID
|
|
103
88
|
|
|
89
|
+
> Nota: o Rails do projeto roda com `wrap_parameters: [:json]` global, então body raiz é auto-wrapped no nome do recurso. Falta de wrapper **não** gera 500 silencioso na maioria dos endpoints — descarte essa hipótese e foque em tipos/estrutura. Detalhes em `api-conventions.md → Wrapper de body`.
|
|
90
|
+
|
|
104
91
|
### "param is missing or the value is empty: <recurso>"
|
|
105
|
-
Status: 400 (
|
|
92
|
+
Status: 400 (raro)
|
|
93
|
+
|
|
94
|
+
Aparece em endpoints que rodam `params.require(:algo)` com nome não-padrão (fora da convenção REST que o auto-wrap deduz). Solução: enviar wrapper explícito `{"<recurso>": {...}}`.
|
|
95
|
+
|
|
96
|
+
### Contato criado com `name`/`phone` vazios após POST /contacts
|
|
97
|
+
Não é 5xx — request volta 200, mas o contato fica sem os dados que você mandou.
|
|
98
|
+
|
|
99
|
+
**Causa:** body foi enviado com wrapper (`{"contact": {"name": "..."}}`). O `ContactsController` usa `params.permit(:name, ...)` direto na raiz, sem `require(:contact)`. Como o auto-wrap não duplica quando o wrapper já está presente, os campos ficam só dentro de `params[:contact]` e o `permit` na raiz não pega.
|
|
106
100
|
|
|
107
|
-
|
|
101
|
+
**Solução:** mandar body raiz: `{"name": "Fulano", "phone_number": "+5511..."}`.
|
|
108
102
|
|
|
109
103
|
### 502 Bad Gateway / 503 Service Unavailable
|
|
110
104
|
Indisponibilidade temporária (deploy, manutenção, sobrecarga).
|