funifier-mcp 0.2.0 → 0.2.4

package/datasource-funifier-docs/knowledge/modules/upload.md

@@ -1,155 +1,155 @@
-# Upload (Upload)
-
-**API Endpoint:** `/v3/upload`
-
-## O que é
-
-Upload de arquivos para uso na gamificação. Permite enviar imagens, documentos e outros tipos de arquivos para utilização em avatares, desafios, recursos visuais ou qualquer outra funcionalidade.
-
-## Quando usar
-
-- Para upload de imagens de avatares
-- Para enviar documentos para treinamentos
-- Para adicionar recursos visuais a desafios e itens
-
-## API Endpoints
-
-### Upload de Imagem
-**Método:** POST
-**Endpoint:** `/v3/upload/image`
-**Content-Type:** multipart/form-data
-
-**Campos do FormData:**
-- `file`: conteúdo da imagem (ex: profile-pic.jpg)
-- `extra`: `{ "session": "images" }`
-
-**Headers:**
-- `Authorization: {token}`
-- `Content-Type: undefined` (gerenciado pelo FormData)
-
-**⚠️ O campo `extra` é obrigatório.** Sem ele, a API retorna erro `Field extra is required`.
-
-**Exemplo de Resposta:**
-```json
-{
-  "uploads": [
-    {
-      "bucket": "funifier/games/{apiKey}/images",
-      "extension": ".jpg",
-      "filename": "profile-pic.jpg",
-      "filename_unique": "{id}_original_profile-pic.jpg",
-      "size": 5559,
-      "content_type": "image/jpeg",
-      "thumb": "original",
-      "extra": { "session": "images" },
-      "_id": "6998ecbc434ba010175f4dd1",
-      "time": 1771629756465,
-      "url": "https://s3.amazonaws.com/funifier/games/{apiKey}/images/{id}_original_profile-pic.jpg"
-    }
-  ],
-  "status": "OK"
-}
-```
-
-### Exclusão de Arquivo por ID
-**Método:** DELETE
-**Endpoint:** `/v3/upload/{id}`
-
-Remove o registro do banco de dados e exclui o arquivo físico do storage (S3/Azure/Google Cloud).
-
-**Headers:**
-- `Authorization: {token}`
-
-**Resposta:** `204 No Content`
-
-**Exemplo:**
-```
-DELETE /v3/upload/6998ecbc434ba010175f4dd1
-Authorization: Bearer eyJhbGciOiJIUzUxMiIs...
-```
-
-**Observação:** A exclusão só é feita se o arquivo pertencer ao mesmo `apiKey` da autorização (verificado pela URL do arquivo).
-
----
-
-### Exclusão de Arquivo por URL
-**Método:** DELETE
-**Endpoint:** `/v3/upload`
-**Content-Type:** application/json
-
-Remove o arquivo pelo campo `url`.
-
-**Body:**
-```json
-{ "url": "https://s3.amazonaws.com/funifier/games/{apiKey}/images/{filename}" }
-```
-
-**Resposta:** `204 No Content`
-
----
-
-
-### Uso com Player (Avatar)
-
-Para usar a imagem como avatar do jogador, após o upload:
-
-```json
-POST /v3/player
-{
-  "_id": "player_id",
-  "image": {
-    "small": { "url": "URL_DO_UPLOAD" },
-    "medium": { "url": "URL_DO_UPLOAD" },
-    "original": { "url": "URL_DO_UPLOAD" }
-  }
-}
-```
-
-**Nota:** O campo `image` do player deve ter o formato `{ small: { url }, medium: { url }, original: { url } }`. A URL é obtida de `response.uploads[0].url`.
-
-### Upload de Arquivo Genérico
-**Método:** POST
-**Endpoint:** `/v3/upload/file`
-**Content-Type:** multipart/form-data
-
-Suporta **qualquer tipo de arquivo** (não apenas imagens). Aceita múltiplos arquivos.
-
-**Campos:**
-- `file`: arquivo binário (pode repetir para vários)
-- `extra`: string JSON obrigatória (ex: `{"session": "docs"}`)
-
-**cURL:**
-```bash
-curl -X POST "{server}/v3/upload/file" \
-  -H "Authorization: Bearer {token}" \
-  -F 'file=@./documento.pdf;type=application/pdf' \
-  -F 'extra={"session":"docs","name":"manual"}'
-```
-
-### Deletar Upload por URL
-**Método:** DELETE
-**Endpoint:** `/v3/upload/image`
-
-**Body:**
-```json
-{ "url": "https://s3.amazonaws.com/funifier/games/{APIKEY}/images/59359e..._logo.png" }
-```
-
-### Listar Uploads
-**Método:** GET
-**Endpoint:** `/v3/upload`
-
-## Triggers de Upload
-
-O upload dispara triggers `BEFORE_CREATE` e `AFTER_CREATE` na entidade `UPLOAD`. Isso permite:
-- Validar arquivos antes de salvar
-- Processar metadados após upload
-- Integrar com outros módulos
-
-## Validações e Testes
-
-- [ ] Upload de imagem retorna URL válida
-- [ ] Upload de arquivo genérico funciona
-- [ ] URL da imagem é acessível publicamente
-- [ ] Diferentes formatos são aceitos (jpg, png, pdf, etc.)
-- [ ] Delete por URL remove o arquivo
+# Upload (Upload)
+
+**API Endpoint:** `/v3/upload`
+
+## O que é
+
+Upload de arquivos para uso na gamificação. Permite enviar imagens, documentos e outros tipos de arquivos para utilização em avatares, desafios, recursos visuais ou qualquer outra funcionalidade.
+
+## Quando usar
+
+- Para upload de imagens de avatares
+- Para enviar documentos para treinamentos
+- Para adicionar recursos visuais a desafios e itens
+
+## API Endpoints
+
+### Upload de Imagem
+**Método:** POST
+**Endpoint:** `/v3/upload/image`
+**Content-Type:** multipart/form-data
+
+**Campos do FormData:**
+- `file`: conteúdo da imagem (ex: profile-pic.jpg)
+- `extra`: `{ "session": "images" }`
+
+**Headers:**
+- `Authorization: {token}`
+- `Content-Type: undefined` (gerenciado pelo FormData)
+
+**⚠️ O campo `extra` é obrigatório.** Sem ele, a API retorna erro `Field extra is required`.
+
+**Exemplo de Resposta:**
+```json
+{
+  "uploads": [
+    {
+      "bucket": "funifier/games/{apiKey}/images",
+      "extension": ".jpg",
+      "filename": "profile-pic.jpg",
+      "filename_unique": "{id}_original_profile-pic.jpg",
+      "size": 5559,
+      "content_type": "image/jpeg",
+      "thumb": "original",
+      "extra": { "session": "images" },
+      "_id": "6998ecbc434ba010175f4dd1",
+      "time": 1771629756465,
+      "url": "https://s3.amazonaws.com/funifier/games/{apiKey}/images/{id}_original_profile-pic.jpg"
+    }
+  ],
+  "status": "OK"
+}
+```
+
+### Exclusão de Arquivo por ID
+**Método:** DELETE
+**Endpoint:** `/v3/upload/{id}`
+
+Remove o registro do banco de dados e exclui o arquivo físico do storage (S3/Azure/Google Cloud).
+
+**Headers:**
+- `Authorization: {token}`
+
+**Resposta:** `204 No Content`
+
+**Exemplo:**
+```
+DELETE /v3/upload/6998ecbc434ba010175f4dd1
+Authorization: Bearer eyJhbGciOiJIUzUxMiIs...
+```
+
+**Observação:** A exclusão só é feita se o arquivo pertencer ao mesmo `apiKey` da autorização (verificado pela URL do arquivo).
+
+---
+
+### Exclusão de Arquivo por URL
+**Método:** DELETE
+**Endpoint:** `/v3/upload`
+**Content-Type:** application/json
+
+Remove o arquivo pelo campo `url`.
+
+**Body:**
+```json
+{ "url": "https://s3.amazonaws.com/funifier/games/{apiKey}/images/{filename}" }
+```
+
+**Resposta:** `204 No Content`
+
+---
+
+
+### Uso com Player (Avatar)
+
+Para usar a imagem como avatar do jogador, após o upload:
+
+```json
+POST /v3/player
+{
+  "_id": "player_id",
+  "image": {
+    "small": { "url": "URL_DO_UPLOAD" },
+    "medium": { "url": "URL_DO_UPLOAD" },
+    "original": { "url": "URL_DO_UPLOAD" }
+  }
+}
+```
+
+**Nota:** O campo `image` do player deve ter o formato `{ small: { url }, medium: { url }, original: { url } }`. A URL é obtida de `response.uploads[0].url`.
+
+### Upload de Arquivo Genérico
+**Método:** POST
+**Endpoint:** `/v3/upload/file`
+**Content-Type:** multipart/form-data
+
+Suporta **qualquer tipo de arquivo** (não apenas imagens). Aceita múltiplos arquivos.
+
+**Campos:**
+- `file`: arquivo binário (pode repetir para vários)
+- `extra`: string JSON obrigatória (ex: `{"session": "docs"}`)
+
+**cURL:**
+```bash
+curl -X POST "{server}/v3/upload/file" \
+  -H "Authorization: Bearer {token}" \
+  -F 'file=@./documento.pdf;type=application/pdf' \
+  -F 'extra={"session":"docs","name":"manual"}'
+```
+
+### Deletar Upload por URL
+**Método:** DELETE
+**Endpoint:** `/v3/upload/image`
+
+**Body:**
+```json
+{ "url": "https://s3.amazonaws.com/funifier/games/{APIKEY}/images/59359e..._logo.png" }
+```
+
+### Listar Uploads
+**Método:** GET
+**Endpoint:** `/v3/upload`
+
+## Triggers de Upload
+
+O upload dispara triggers `BEFORE_CREATE` e `AFTER_CREATE` na entidade `UPLOAD`. Isso permite:
+- Validar arquivos antes de salvar
+- Processar metadados após upload
+- Integrar com outros módulos
+
+## Validações e Testes
+
+- [ ] Upload de imagem retorna URL válida
+- [ ] Upload de arquivo genérico funciona
+- [ ] URL da imagem é acessível publicamente
+- [ ] Diferentes formatos são aceitos (jpg, png, pdf, etc.)
+- [ ] Delete por URL remove o arquivo

package/datasource-funifier-docs/knowledge/modules/virtual-good.md

@@ -1,99 +1,99 @@
-# Virtual Good (Loja Virtual)
-
-**Acesso Studio:** `/studio/catalog`
-**API Endpoint:** `/v3/virtualgoods`
-
-## O que é
-
-Cadastro e gestão de objetos e benefícios que podem ser adquiridos pelos jogadores. Permite cadastrar produtos físicos, virtuais ou benefícios, estipular preços, quantidades, limites de compra e atributos. Os jogadores trocam pontos ou itens por objetos na loja.
-
-## Quando usar
-
-- Para criar sistema de recompensas tangíveis
-- Para monetizar pontos/moedas virtuais
-- Para dar senso de propriedade e escolha ao jogador
-- Exemplos: camisetas, gift cards, itens virtuais, acessórios de avatar
-
-## Dependências
-
-- **Point**: moeda para compra deve existir
-
-## Checklist de Configuração no Studio
-
-- [ ] Criar catálogo (ex: "gifts", "rewards")
-- [ ] Criar itens dentro do catálogo
-- [ ] Definir preço (requires: tipo de ponto + quantidade)
-- [ ] Definir quantidade em estoque (amount, -1 = ilimitado)
-- [ ] Definir limite de compras por jogador
-- [ ] Ativar item (active: true)
-
-## API Endpoints
-
-### Listar Catálogos
-**Método:** GET
-**Endpoint:** `/v3/virtualgoods/catalog`
-
-### Criar Catálogo
-**Método:** POST
-**Endpoint:** `/v3/virtualgoods/catalog`
-
-**Exemplo de Body:**
-```json
-{
-  "catalog": "Gifts",
-  "extra": {},
-  "i18n": {},
-  "_id": "gifts"
-}
-```
-
-### Listar Itens
-**Método:** GET
-**Endpoint:** `/v3/virtualgoods/item`
-
-### Criar Item
-**Método:** POST
-**Endpoint:** `/v3/virtualgoods/item`
-
-**Exemplo de Body:**
-```json
-{
-  "catalogId": "gifts",
-  "name": "Bike",
-  "description": "Electric bike",
-  "amount": -1,
-  "active": true,
-  "extra": {},
-  "requires": [],
-  "rewards": [],
-  "notifications": [],
-  "i18n": {},
-  "techniques": ["GT08"],
-  "_id": "DTj7lVn"
-}
-```
-
-### Realizar Compra
-**Método:** POST
-**Endpoint:** `/v3/virtualgoods/purchase`
-
-**Exemplo de Body:**
-```json
-{
-  "player": "tom",
-  "item": "DTj7lVn",
-  "total": 1
-}
-```
-
-### Excluir Compra
-**Método:** DELETE
-**Endpoint:** `/v3/virtualgoods/purchase`
-
-## Validações e Testes
-
-- [ ] Catálogo e itens aparecem nas respectivas listas
-- [ ] Jogador consegue comprar item com saldo suficiente
-- [ ] Compra debita pontos corretamente
-- [ ] Estoque é decrementado (se não ilimitado)
-- [ ] Limite de compras por jogador é respeitado
+# Virtual Good (Loja Virtual)
+
+**Acesso Studio:** `/studio/catalog`
+**API Endpoint:** `/v3/virtualgoods`
+
+## O que é
+
+Cadastro e gestão de objetos e benefícios que podem ser adquiridos pelos jogadores. Permite cadastrar produtos físicos, virtuais ou benefícios, estipular preços, quantidades, limites de compra e atributos. Os jogadores trocam pontos ou itens por objetos na loja.
+
+## Quando usar
+
+- Para criar sistema de recompensas tangíveis
+- Para monetizar pontos/moedas virtuais
+- Para dar senso de propriedade e escolha ao jogador
+- Exemplos: camisetas, gift cards, itens virtuais, acessórios de avatar
+
+## Dependências
+
+- **Point**: moeda para compra deve existir
+
+## Checklist de Configuração no Studio
+
+- [ ] Criar catálogo (ex: "gifts", "rewards")
+- [ ] Criar itens dentro do catálogo
+- [ ] Definir preço (requires: tipo de ponto + quantidade)
+- [ ] Definir quantidade em estoque (amount, -1 = ilimitado)
+- [ ] Definir limite de compras por jogador
+- [ ] Ativar item (active: true)
+
+## API Endpoints
+
+### Listar Catálogos
+**Método:** GET
+**Endpoint:** `/v3/virtualgoods/catalog`
+
+### Criar Catálogo
+**Método:** POST
+**Endpoint:** `/v3/virtualgoods/catalog`
+
+**Exemplo de Body:**
+```json
+{
+  "catalog": "Gifts",
+  "extra": {},
+  "i18n": {},
+  "_id": "gifts"
+}
+```
+
+### Listar Itens
+**Método:** GET
+**Endpoint:** `/v3/virtualgoods/item`
+
+### Criar Item
+**Método:** POST
+**Endpoint:** `/v3/virtualgoods/item`
+
+**Exemplo de Body:**
+```json
+{
+  "catalogId": "gifts",
+  "name": "Bike",
+  "description": "Electric bike",
+  "amount": -1,
+  "active": true,
+  "extra": {},
+  "requires": [],
+  "rewards": [],
+  "notifications": [],
+  "i18n": {},
+  "techniques": ["GT08"],
+  "_id": "DTj7lVn"
+}
+```
+
+### Realizar Compra
+**Método:** POST
+**Endpoint:** `/v3/virtualgoods/purchase`
+
+**Exemplo de Body:**
+```json
+{
+  "player": "tom",
+  "item": "DTj7lVn",
+  "total": 1
+}
+```
+
+### Excluir Compra
+**Método:** DELETE
+**Endpoint:** `/v3/virtualgoods/purchase`
+
+## Validações e Testes
+
+- [ ] Catálogo e itens aparecem nas respectivas listas
+- [ ] Jogador consegue comprar item com saldo suficiente
+- [ ] Compra debita pontos corretamente
+- [ ] Estoque é decrementado (se não ilimitado)
+- [ ] Limite de compras por jogador é respeitado

package/datasource-funifier-docs/knowledge/modules/webhook.md

@@ -1,41 +1,41 @@
-# WebHook (WebHook)
-
-**API Endpoint:** `/v3/webhook`
-
-## O que é
-
-Notificações automáticas para endpoints externos em tempo real. Permite que a Funifier envie notificações automáticas (payloads) para sistemas externos sempre que eventos importantes ocorrem na gamificação, sem necessidade de polling.
-
-## Quando usar
-
-- Para enviar dados para sistemas de BI quando um desafio é completado
-- Para notificar CRM quando jogador atinge uma meta
-- Para integrar com ferramentas externas (Slack, Teams, etc.)
-- Para sincronizar dados em tempo real com outros sistemas
-
-## Checklist de Configuração
-
-- [ ] Definir URL do endpoint externo
-- [ ] Definir eventos que disparam o webhook
-- [ ] Definir formato do payload
-- [ ] Testar conectividade com endpoint
-
-## API Endpoints
-
-### Listar Webhooks
-**Método:** GET
-**Endpoint:** `/v3/webhook`
-
-### Criar Webhook
-**Método:** POST
-**Endpoint:** `/v3/webhook`
-
-### Deletar Webhook
-**Método:** DELETE
-**Endpoint:** `/v3/webhook/:id`
-
-## Validações e Testes
-
-- [ ] Webhook aparece na lista
-- [ ] Payload é enviado quando evento ocorre
-- [ ] Endpoint externo recebe dados corretamente
+# WebHook (WebHook)
+
+**API Endpoint:** `/v3/webhook`
+
+## O que é
+
+Notificações automáticas para endpoints externos em tempo real. Permite que a Funifier envie notificações automáticas (payloads) para sistemas externos sempre que eventos importantes ocorrem na gamificação, sem necessidade de polling.
+
+## Quando usar
+
+- Para enviar dados para sistemas de BI quando um desafio é completado
+- Para notificar CRM quando jogador atinge uma meta
+- Para integrar com ferramentas externas (Slack, Teams, etc.)
+- Para sincronizar dados em tempo real com outros sistemas
+
+## Checklist de Configuração
+
+- [ ] Definir URL do endpoint externo
+- [ ] Definir eventos que disparam o webhook
+- [ ] Definir formato do payload
+- [ ] Testar conectividade com endpoint
+
+## API Endpoints
+
+### Listar Webhooks
+**Método:** GET
+**Endpoint:** `/v3/webhook`
+
+### Criar Webhook
+**Método:** POST
+**Endpoint:** `/v3/webhook`
+
+### Deletar Webhook
+**Método:** DELETE
+**Endpoint:** `/v3/webhook/:id`
+
+## Validações e Testes
+
+- [ ] Webhook aparece na lista
+- [ ] Payload é enviado quando evento ocorre
+- [ ] Endpoint externo recebe dados corretamente

package/datasource-funifier-docs/knowledge/modules/websocket.md

@@ -1,41 +1,41 @@
-# WebSocket (WebSocket)
-
-**Acesso Studio:** `/studio/websocket`
-**API Endpoint:** `/v3/websocket`
-
-## O que é
-
-Entrega de feedbacks em tempo real e interação instantânea entre jogadores. Permite configurar rotinas para enviar e receber informações instantaneamente entre jogadores e o sistema, sem precisar recarregar a página.
-
-## Quando usar
-
-- Para comunicação em tempo real durante competições
-- Para feedback instantâneo ao completar desafios
-- Para chats ao vivo entre jogadores
-- Para atualização de status em tempo real
-
-## Checklist de Configuração no Studio
-
-- [ ] Configurar rotinas de websocket
-- [ ] Definir eventos que disparam mensagens
-- [ ] Configurar canais de comunicação
-
-## API Endpoints
-
-### Listar WebSockets
-**Método:** GET
-**Endpoint:** `/v3/websocket`
-
-### Criar WebSocket
-**Método:** POST
-**Endpoint:** `/v3/websocket`
-
-### Deletar WebSocket
-**Método:** DELETE
-**Endpoint:** `/v3/websocket/:id`
-
-## Validações e Testes
-
-- [ ] WebSocket aparece na lista
-- [ ] Mensagens são entregues em tempo real
-- [ ] Conexão se mantém estável
+# WebSocket (WebSocket)
+
+**Acesso Studio:** `/studio/websocket`
+**API Endpoint:** `/v3/websocket`
+
+## O que é
+
+Entrega de feedbacks em tempo real e interação instantânea entre jogadores. Permite configurar rotinas para enviar e receber informações instantaneamente entre jogadores e o sistema, sem precisar recarregar a página.
+
+## Quando usar
+
+- Para comunicação em tempo real durante competições
+- Para feedback instantâneo ao completar desafios
+- Para chats ao vivo entre jogadores
+- Para atualização de status em tempo real
+
+## Checklist de Configuração no Studio
+
+- [ ] Configurar rotinas de websocket
+- [ ] Definir eventos que disparam mensagens
+- [ ] Configurar canais de comunicação
+
+## API Endpoints
+
+### Listar WebSockets
+**Método:** GET
+**Endpoint:** `/v3/websocket`
+
+### Criar WebSocket
+**Método:** POST
+**Endpoint:** `/v3/websocket`
+
+### Deletar WebSocket
+**Método:** DELETE
+**Endpoint:** `/v3/websocket/:id`
+
+## Validações e Testes
+
+- [ ] WebSocket aparece na lista
+- [ ] Mensagens são entregues em tempo real
+- [ ] Conexão se mantém estável