funifier-mcp 0.2.0 → 0.2.3

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

@@ -1,80 +1,80 @@
-# Action (Ação)
-
-**Acesso Studio:** `/studio/action`
-**API Endpoint:** `/v3/action`
-
-## O que é
-
-Cadastro das diferentes ações que os jogadores podem realizar na gamificação. Permite criar e configurar todas as ações possíveis dentro da experiência gamificada, como "vender", "comprar", "comentar", "compartilhar", entre outras. As ações são a base da estratégia de engajamento, pois definem o que é possível fazer na gamificação e servem para disparar regras e recompensas. É possível adicionar atributos extras a cada ação, por exemplo, "produto" e "valor" na ação de venda.
-
-## Quando usar
-
-- Em todo projeto de gamificação (obrigatório)
-- Para definir os comportamentos que serão rastreados
-- Para criar a base de eventos que disparam desafios e recompensas
-
-## Checklist de Configuração no Studio
-
-- [ ] Definir o _id da ação (letras minúsculas, sem espaços ou acentos)
-- [ ] Definir o nome amigável da ação (inicial maiúscula)
-- [ ] Definir atributos extras se necessário (name + type: String, Number ou Boolean)
-- [ ] Ativar a ação (active: true)
-- [ ] Boas práticas: criar ações genéricas e usar atributos para detalhar contexto
-
-## API Endpoints
-
-### Listar Ações
-**Método:** GET
-**Endpoint:** `/v3/action`
-**Descrição:** Retorna a lista de ações configuradas na gamificação.
-
-**Exemplo de Resposta:**
-```json
-[
-  {
-    "action": "Sell",
-    "attributes": [
-      { "name": "product", "type": "String" },
-      { "name": "price", "type": "Number" }
-    ],
-    "active": true,
-    "_id": "sell"
-  }
-]
-```
-
-### Criar Ação
-**Método:** POST
-**Endpoint:** `/v3/action`
-**Descrição:** Cria uma nova ação com nome, atributos e status de ativação.
-
-**Exemplo de Body:**
-```json
-{
-  "_id": "sell",
-  "active": true,
-  "action": "Sell",
-  "attributes": [
-    { "name": "product", "type": "String" },
-    { "name": "price", "type": "Number" }
-  ]
-}
-```
-
-### Excluir Ação
-**Método:** DELETE
-**Endpoint:** `/v3/action/:id`
-**Descrição:** Remove uma ação da gamificação.
-
-## Boas Práticas
-
-- Crie ações genéricas como "comprar", "vender", "responder", "visitar"
-- Use os atributos para detalhar o contexto da ação (ex: produto, local, valor)
-- Evite criar uma ação diferente para cada variação. Exemplo errado: "comprar sapato", "comprar camisa". Exemplo certo: ação "comprar" com atributo "produto"
-
-## Validações e Testes
-
-- [ ] Ação aparece na lista GET /v3/action
-- [ ] Ação tem _id único e sem caracteres especiais
-- [ ] Atributos estão com tipos corretos (String, Number, Boolean)
-- [ ] Ação está ativa (active: true)
+# Action (Ação)
+
+**Acesso Studio:** `/studio/action`
+**API Endpoint:** `/v3/action`
+
+## O que é
+
+Cadastro das diferentes ações que os jogadores podem realizar na gamificação. Permite criar e configurar todas as ações possíveis dentro da experiência gamificada, como "vender", "comprar", "comentar", "compartilhar", entre outras. As ações são a base da estratégia de engajamento, pois definem o que é possível fazer na gamificação e servem para disparar regras e recompensas. É possível adicionar atributos extras a cada ação, por exemplo, "produto" e "valor" na ação de venda.
+
+## Quando usar
+
+- Em todo projeto de gamificação (obrigatório)
+- Para definir os comportamentos que serão rastreados
+- Para criar a base de eventos que disparam desafios e recompensas
+
+## Checklist de Configuração no Studio
+
+- [ ] Definir o _id da ação (letras minúsculas, sem espaços ou acentos)
+- [ ] Definir o nome amigável da ação (inicial maiúscula)
+- [ ] Definir atributos extras se necessário (name + type: String, Number ou Boolean)
+- [ ] Ativar a ação (active: true)
+- [ ] Boas práticas: criar ações genéricas e usar atributos para detalhar contexto
+
+## API Endpoints
+
+### Listar Ações
+**Método:** GET
+**Endpoint:** `/v3/action`
+**Descrição:** Retorna a lista de ações configuradas na gamificação.
+
+**Exemplo de Resposta:**
+```json
+[
+  {
+    "action": "Sell",
+    "attributes": [
+      { "name": "product", "type": "String" },
+      { "name": "price", "type": "Number" }
+    ],
+    "active": true,
+    "_id": "sell"
+  }
+]
+```
+
+### Criar Ação
+**Método:** POST
+**Endpoint:** `/v3/action`
+**Descrição:** Cria uma nova ação com nome, atributos e status de ativação.
+
+**Exemplo de Body:**
+```json
+{
+  "_id": "sell",
+  "active": true,
+  "action": "Sell",
+  "attributes": [
+    { "name": "product", "type": "String" },
+    { "name": "price", "type": "Number" }
+  ]
+}
+```
+
+### Excluir Ação
+**Método:** DELETE
+**Endpoint:** `/v3/action/:id`
+**Descrição:** Remove uma ação da gamificação.
+
+## Boas Práticas
+
+- Crie ações genéricas como "comprar", "vender", "responder", "visitar"
+- Use os atributos para detalhar o contexto da ação (ex: produto, local, valor)
+- Evite criar uma ação diferente para cada variação. Exemplo errado: "comprar sapato", "comprar camisa". Exemplo certo: ação "comprar" com atributo "produto"
+
+## Validações e Testes
+
+- [ ] Ação aparece na lista GET /v3/action
+- [ ] Ação tem _id único e sem caracteres especiais
+- [ ] Atributos estão com tipos corretos (String, Number, Boolean)
+- [ ] Ação está ativa (active: true)

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

@@ -1,104 +1,104 @@
-# Auth (Autenticação)
-
-**Acesso Studio:** `/studio/auth`
-**API Endpoint:** `/v3/auth`
-
-## O que é
-
-Gerenciamento de autenticação e critérios básicos de segurança. Permite configurar como será o processo de login dos jogadores, definindo exigência de senha, auto-criação de usuários, geração de tokens de acesso (incluindo tempo de expiração e revalidação). Também permite criar rotinas personalizadas de autenticação (Auth Module) para SSO, validação externa e logs de login.
-
-## Quando usar
-
-- Para configurar login de jogadores
-- Para gerar tokens de acesso
-- Para implementar SSO com sistemas corporativos
-- Para criar validações customizadas de autenticação
-
-## Checklist de Configuração no Studio
-
-- [ ] Definir se senha é obrigatória
-- [ ] Configurar auto-criação de usuários
-- [ ] Definir tempo de expiração do token
-- [ ] Configurar módulo de autenticação customizado (se necessário)
-
-## API Endpoints
-
-### Autenticar Jogador
-**Método:** POST
-**Endpoint:** `/v3/auth/token`
-
-**Exemplo de Body:**
-```json
-{
-  "apiKey": "YOUR_API_KEY",
-  "grant_type": "password",
-  "username": "tom",
-  "password": "123"
-}
-```
-
-**Exemplo de Resposta:**
-```json
-{
-  "access_token": "eyJhbGciOiJIUzUxMiIsImNhbGciOiJHWklQIn0...",
-  "token_type": "Bearer",
-  "expires_in": 1695751444626
-}
-```
-
-### Listar Módulos de Autenticação
-**Método:** GET
-**Endpoint:** `/v3/auth/module`
-
-### Criar Módulo de Autenticação
-**Método:** POST
-**Endpoint:** `/v3/auth/module`
-
-## Roles e Permissões (Scopes)
-
-As permissões do token de jogador são controladas por **Roles** configuradas em `Studio > Security > Roles`. Cada Role define:
-
-- **Role:** nome da role (ex: `player`) — atribuída automaticamente ao jogador no login
-- **Timeout:** tempo de expiração do token (ex: `1d` = 1 dia)
-- **Scope:** lista de permissões separadas por vírgula
-
-### Scopes disponíveis
-
-| Scope | Descrição |
-|-------|-----------|
-| `read_all` | Leitura em todos os endpoints |
-| `write_all` | Escrita em todos os endpoints |
-| `delete_all` | Exclusão em todos os endpoints |
-| `write_player` | Escrita no endpoint `/v3/player` |
-| `write_actionlog` | Escrita no endpoint `/v3/action_log` |
-| `write_upload` | Escrita no endpoint `/v3/upload` |
-| `write_database_<collection>` | Escrita em uma coleção específica do database (ex: `write_database_task__c`) |
-| `delete_database_<collection>` | Exclusão em uma coleção específica do database |
-| `database` | **⚠️ OBRIGATÓRIO** para acessar o endpoint `/v3/database` — sem esta palavra no scope, o endpoint retorna dados vazios silenciosamente (sem erro) |
-
-### ⚠️ Nota importante sobre o endpoint Database
-
-O endpoint `/v3/database` exige que a palavra **`database`** esteja presente no scope da role, **independentemente** de `write_all` ou `read_all` já estarem configurados. Sem ela, as operações de escrita retornam `201` mas **não persistem os dados**, e as operações de leitura retornam **corpo vazio** — tudo sem mensagem de erro.
-
-### Exemplo de scope completo para apps com database
-
-```
-read_all, write_all, delete_all, database
-```
-
-### Configuração no Studio
-
-1. Acesse `Studio > Security`
-2. Na seção **Roles**, clique no botão `+` para criar uma nova role
-3. Defina: Role = `player`, Timeout = `1d`, Scope = `read_all, write_all, delete_all, database`
-4. Clique em **Salvar**
-5. O jogador precisa **fazer login novamente** para obter um token com as novas permissões
-
-## Validações e Testes
-
-- [ ] Login retorna token válido
-- [ ] Token expira no tempo configurado
-- [ ] Jogador inválido recebe erro apropriado
-- [ ] SSO funciona (se configurado)
-- [ ] Role "player" está configurada com scope adequado
-- [ ] Token do jogador tem permissão para os endpoints necessários
+# Auth (Autenticação)
+
+**Acesso Studio:** `/studio/auth`
+**API Endpoint:** `/v3/auth`
+
+## O que é
+
+Gerenciamento de autenticação e critérios básicos de segurança. Permite configurar como será o processo de login dos jogadores, definindo exigência de senha, auto-criação de usuários, geração de tokens de acesso (incluindo tempo de expiração e revalidação). Também permite criar rotinas personalizadas de autenticação (Auth Module) para SSO, validação externa e logs de login.
+
+## Quando usar
+
+- Para configurar login de jogadores
+- Para gerar tokens de acesso
+- Para implementar SSO com sistemas corporativos
+- Para criar validações customizadas de autenticação
+
+## Checklist de Configuração no Studio
+
+- [ ] Definir se senha é obrigatória
+- [ ] Configurar auto-criação de usuários
+- [ ] Definir tempo de expiração do token
+- [ ] Configurar módulo de autenticação customizado (se necessário)
+
+## API Endpoints
+
+### Autenticar Jogador
+**Método:** POST
+**Endpoint:** `/v3/auth/token`
+
+**Exemplo de Body:**
+```json
+{
+  "apiKey": "YOUR_API_KEY",
+  "grant_type": "password",
+  "username": "tom",
+  "password": "123"
+}
+```
+
+**Exemplo de Resposta:**
+```json
+{
+  "access_token": "eyJhbGciOiJIUzUxMiIsImNhbGciOiJHWklQIn0...",
+  "token_type": "Bearer",
+  "expires_in": 1695751444626
+}
+```
+
+### Listar Módulos de Autenticação
+**Método:** GET
+**Endpoint:** `/v3/auth/module`
+
+### Criar Módulo de Autenticação
+**Método:** POST
+**Endpoint:** `/v3/auth/module`
+
+## Roles e Permissões (Scopes)
+
+As permissões do token de jogador são controladas por **Roles** configuradas em `Studio > Security > Roles`. Cada Role define:
+
+- **Role:** nome da role (ex: `player`) — atribuída automaticamente ao jogador no login
+- **Timeout:** tempo de expiração do token (ex: `1d` = 1 dia)
+- **Scope:** lista de permissões separadas por vírgula
+
+### Scopes disponíveis
+
+| Scope | Descrição |
+|-------|-----------|
+| `read_all` | Leitura em todos os endpoints |
+| `write_all` | Escrita em todos os endpoints |
+| `delete_all` | Exclusão em todos os endpoints |
+| `write_player` | Escrita no endpoint `/v3/player` |
+| `write_actionlog` | Escrita no endpoint `/v3/action_log` |
+| `write_upload` | Escrita no endpoint `/v3/upload` |
+| `write_database_<collection>` | Escrita em uma coleção específica do database (ex: `write_database_task__c`) |
+| `delete_database_<collection>` | Exclusão em uma coleção específica do database |
+| `database` | **⚠️ OBRIGATÓRIO** para acessar o endpoint `/v3/database` — sem esta palavra no scope, o endpoint retorna dados vazios silenciosamente (sem erro) |
+
+### ⚠️ Nota importante sobre o endpoint Database
+
+O endpoint `/v3/database` exige que a palavra **`database`** esteja presente no scope da role, **independentemente** de `write_all` ou `read_all` já estarem configurados. Sem ela, as operações de escrita retornam `201` mas **não persistem os dados**, e as operações de leitura retornam **corpo vazio** — tudo sem mensagem de erro.
+
+### Exemplo de scope completo para apps com database
+
+```
+read_all, write_all, delete_all, database
+```
+
+### Configuração no Studio
+
+1. Acesse `Studio > Security`
+2. Na seção **Roles**, clique no botão `+` para criar uma nova role
+3. Defina: Role = `player`, Timeout = `1d`, Scope = `read_all, write_all, delete_all, database`
+4. Clique em **Salvar**
+5. O jogador precisa **fazer login novamente** para obter um token com as novas permissões
+
+## Validações e Testes
+
+- [ ] Login retorna token válido
+- [ ] Token expira no tempo configurado
+- [ ] Jogador inválido recebe erro apropriado
+- [ ] SSO funciona (se configurado)
+- [ ] Role "player" está configurada com scope adequado
+- [ ] Token do jogador tem permissão para os endpoints necessários

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

@@ -1,28 +1,28 @@
-# Avatar (Avatar)
-
-## O que é
-
-Criação e customização de avatares para os jogadores. Permite aos jogadores criarem avatares personalizados, desbloqueando acessórios e itens de acordo com o desempenho na gamificação ou por compras na loja. Pode ser usado em ambientes 2D ou 3D.
-
-## Quando usar
-
-- Para personalização visual dos jogadores
-- Para criar senso de identidade e pertencimento
-- Para vincular recompensas a itens visuais
-- Para ambientes virtuais com representação do jogador
-
-## Dependências
-
-- **Virtual Good** (opcional): acessórios podem ser vendidos na loja
-
-## Checklist de Configuração
-
-- [ ] Definir tipos de avatar disponíveis
-- [ ] Criar acessórios e itens desbloqueáveis
-- [ ] Vincular itens a desafios ou loja virtual
-
-## Validações e Testes
-
-- [ ] Avatar padrão é exibido para novos jogadores
-- [ ] Acessórios desbloqueados aparecem disponíveis
-- [ ] Personalização do avatar é salva corretamente
+# Avatar (Avatar)
+
+## O que é
+
+Criação e customização de avatares para os jogadores. Permite aos jogadores criarem avatares personalizados, desbloqueando acessórios e itens de acordo com o desempenho na gamificação ou por compras na loja. Pode ser usado em ambientes 2D ou 3D.
+
+## Quando usar
+
+- Para personalização visual dos jogadores
+- Para criar senso de identidade e pertencimento
+- Para vincular recompensas a itens visuais
+- Para ambientes virtuais com representação do jogador
+
+## Dependências
+
+- **Virtual Good** (opcional): acessórios podem ser vendidos na loja
+
+## Checklist de Configuração
+
+- [ ] Definir tipos de avatar disponíveis
+- [ ] Criar acessórios e itens desbloqueáveis
+- [ ] Vincular itens a desafios ou loja virtual
+
+## Validações e Testes
+
+- [ ] Avatar padrão é exibido para novos jogadores
+- [ ] Acessórios desbloqueados aparecem disponíveis
+- [ ] Personalização do avatar é salva corretamente

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

@@ -1,40 +1,40 @@
-# Backup (Backup)
-
-**Acesso Studio:** `/studio/backup`
-**API Endpoint:** `/v3/backup`
-
-## O que é
-
-Backup e remoção controlada de dados antigos. Permite criar rotinas automáticas de backup de registros importantes, além de remover dados antigos de maneira controlada para manter a performance da plataforma.
-
-## Quando usar
-
-- Para fazer backup de logs antigos antes de atualizações
-- Para remover registros históricos e otimizar consultas
-- Para manter performance em grandes volumes de dados
-
-## Checklist de Configuração no Studio
-
-- [ ] Definir quais coleções serão backupeadas
-- [ ] Configurar frequência do backup
-- [ ] Definir critério de remoção de dados antigos
-
-## API Endpoints
-
-### Listar Backups
-**Método:** GET
-**Endpoint:** `/v3/backup`
-
-### Criar Backup
-**Método:** POST
-**Endpoint:** `/v3/backup`
-
-### Deletar Backup
-**Método:** DELETE
-**Endpoint:** `/v3/backup/:id`
-
-## Validações e Testes
-
-- [ ] Backup é executado com sucesso
-- [ ] Dados antigos são removidos conforme critério
-- [ ] Performance melhora após limpeza
+# Backup (Backup)
+
+**Acesso Studio:** `/studio/backup`
+**API Endpoint:** `/v3/backup`
+
+## O que é
+
+Backup e remoção controlada de dados antigos. Permite criar rotinas automáticas de backup de registros importantes, além de remover dados antigos de maneira controlada para manter a performance da plataforma.
+
+## Quando usar
+
+- Para fazer backup de logs antigos antes de atualizações
+- Para remover registros históricos e otimizar consultas
+- Para manter performance em grandes volumes de dados
+
+## Checklist de Configuração no Studio
+
+- [ ] Definir quais coleções serão backupeadas
+- [ ] Configurar frequência do backup
+- [ ] Definir critério de remoção de dados antigos
+
+## API Endpoints
+
+### Listar Backups
+**Método:** GET
+**Endpoint:** `/v3/backup`
+
+### Criar Backup
+**Método:** POST
+**Endpoint:** `/v3/backup`
+
+### Deletar Backup
+**Método:** DELETE
+**Endpoint:** `/v3/backup/:id`
+
+## Validações e Testes
+
+- [ ] Backup é executado com sucesso
+- [ ] Dados antigos são removidos conforme critério
+- [ ] Performance melhora após limpeza