funifier-mcp 0.2.0 → 0.2.4

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

@@ -1,136 +1,136 @@
-# Question (Pergunta)
-
-**Acesso Studio:** `/studio/question`
-**API Endpoint:** `/v3/question`
-
-## O que é
-
-Configuração de perguntas e respostas para os jogadores. Permite criar perguntas em diferentes formatos (múltipla escolha, verdadeiro/falso, com mídia), definir respostas corretas ou colher opiniões, e aplicar pesos diferentes para as perguntas. A apresentação pode ser no formato tradicional ou em mini games como caça-palavras e cruzadinhas.
-
-## Quando usar
-
-- Para criar quizzes e avaliações
-- Para pesquisas de opinião
-- Para treinamentos e capacitação
-- Para mini games educativos
-
-## Checklist de Configuração no Studio
-
-- [ ] Definir tipo da pergunta (MULTIPLE_CHOICE, TRUE_FALSE, etc.)
-- [ ] Definir título e texto da pergunta
-- [ ] Criar opções de resposta com grades (pontuação)
-- [ ] Definir se permite uma ou múltiplas respostas (select)
-- [ ] Configurar embaralhamento (shuffle)
-- [ ] Definir peso/grade da pergunta
-
-## API Endpoints
-
-### Listar Perguntas
-**Método:** GET
-**Endpoint:** `/v3/question`
-
-### Criar Pergunta
-**Método:** POST
-**Endpoint:** `/v3/question`
-
-**Exemplo de Body:**
-```json
-{
-  "_id": "64a5b2c2d8dcca49bcf7eb6e",
-  "type": "MULTIPLE_CHOICE",
-  "title": "Visual Components",
-  "question": "In Funifier, what is the small visual components that can be added to a web page to display feedbacks?",
-  "grade": 1,
-  "choices": [
-    { "answer": "1", "label": "Points", "grade": 0, "extra": {} },
-    { "answer": "2", "label": "Badges", "grade": 0, "extra": {} },
-    { "answer": "3", "label": "Challenges", "grade": 0, "extra": {} },
-    { "answer": "4", "label": "Leaderboards", "grade": 0, "extra": {} },
-    { "answer": "5", "label": "Widgets", "grade": 1, "extra": {} }
-  ],
-  "techniques": ["GT05"],
-  "select": "one_answer",
-  "answerNumbering": "uppercase_letters",
-  "shuffle": false,
-  "feedbacks": [],
-  "extra": {}
-}
-```
-
-### Deletar Pergunta
-**Método:** DELETE
-**Endpoint:** `/v3/question/:id`
-
-### Listar Respostas de Jogadores
-**Método:** GET
-**Endpoint:** `/v3/question/log?question=:id`
-
-### Criar Resposta de Jogador
-**Método:** POST
-**Endpoint:** `/v3/question/log`
-
-**Exemplo de Body:**
-```json
-{
-  "question": "64a5b2c2d8dcca49bcf7eb6e",
-  "answer": ["5"],
-  "player": "tom"
-}
-```
-
-### Deletar Resposta
-**Método:** DELETE
-**Endpoint:** `/v3/question/log/:id`
-
-## Tipos de Pergunta
-
-| Tipo | Descrição |
-|------|-----------|
-| `MULTIPLE_CHOICE` | Múltipla escolha (uma ou várias respostas) |
-| `TRUE_FALSE` | Verdadeiro ou Falso |
-| `ESSAY` | Dissertativa (resposta livre) |
-| `CROSSWORD` | Caça-palavras (mini game) |
-| `WORD_SEARCH` | Cruzadinha (mini game) |
-
-## Campos Importantes
-
-| Campo | Tipo | Descrição |
-|-------|------|-----------|
-| `quiz` | String | ID do quiz pai (vincula pergunta ao quiz) |
-| `type` | String | Tipo da pergunta (ver tabela acima) |
-| `question` | String | Texto da pergunta |
-| `grade` | Number | Peso/pontuação da pergunta |
-| `choices` | Array | Opções de resposta (ver estrutura abaixo) |
-| `select` | String | `one_answer` ou `multiple_answers` |
-| `shuffle` | Boolean | Embaralhar opções |
-| `techniques` | Array | IDs de técnicas de jogos vinculadas |
-
-### Estrutura de Choice (Opção de Resposta)
-
-```json
-{
-  "answer": "1",           // identificador único da opção
-  "label": "Funifier",     // texto exibido
-  "grade": 1,              // pontuação se escolhida (0 = errada)
-  "gradePercent": 100,     // percentual de acerto
-  "gradeCheck": true,      // indica se é resposta correta
-  "extra": {}              // metadados adicionais
-}
-```
-
-## Formatos de Apresentação
-
-Perguntas podem incluir conteúdo rico:
-- Texto com HTML
-- Imagens (campo `image`)
-- Vídeos e áudio (via `extra`)
-- Mini games (caça-palavras, cruzadinha)
-
-## Validações e Testes
-
-- [ ] Pergunta aparece na lista GET /v3/question
-- [ ] Resposta do jogador é registrada corretamente (POST /v3/question/log)
-- [ ] Grade é calculada com base na resposta
-- [ ] Opções de resposta estão corretas
-- [ ] Vinculação com quiz funciona (campo `quiz`)
-- [ ] Registro em lote funciona (POST /v3/question/log/bulk)
+# Question (Pergunta)
+
+**Acesso Studio:** `/studio/question`
+**API Endpoint:** `/v3/question`
+
+## O que é
+
+Configuração de perguntas e respostas para os jogadores. Permite criar perguntas em diferentes formatos (múltipla escolha, verdadeiro/falso, com mídia), definir respostas corretas ou colher opiniões, e aplicar pesos diferentes para as perguntas. A apresentação pode ser no formato tradicional ou em mini games como caça-palavras e cruzadinhas.
+
+## Quando usar
+
+- Para criar quizzes e avaliações
+- Para pesquisas de opinião
+- Para treinamentos e capacitação
+- Para mini games educativos
+
+## Checklist de Configuração no Studio
+
+- [ ] Definir tipo da pergunta (MULTIPLE_CHOICE, TRUE_FALSE, etc.)
+- [ ] Definir título e texto da pergunta
+- [ ] Criar opções de resposta com grades (pontuação)
+- [ ] Definir se permite uma ou múltiplas respostas (select)
+- [ ] Configurar embaralhamento (shuffle)
+- [ ] Definir peso/grade da pergunta
+
+## API Endpoints
+
+### Listar Perguntas
+**Método:** GET
+**Endpoint:** `/v3/question`
+
+### Criar Pergunta
+**Método:** POST
+**Endpoint:** `/v3/question`
+
+**Exemplo de Body:**
+```json
+{
+  "_id": "64a5b2c2d8dcca49bcf7eb6e",
+  "type": "MULTIPLE_CHOICE",
+  "title": "Visual Components",
+  "question": "In Funifier, what is the small visual components that can be added to a web page to display feedbacks?",
+  "grade": 1,
+  "choices": [
+    { "answer": "1", "label": "Points", "grade": 0, "extra": {} },
+    { "answer": "2", "label": "Badges", "grade": 0, "extra": {} },
+    { "answer": "3", "label": "Challenges", "grade": 0, "extra": {} },
+    { "answer": "4", "label": "Leaderboards", "grade": 0, "extra": {} },
+    { "answer": "5", "label": "Widgets", "grade": 1, "extra": {} }
+  ],
+  "techniques": ["GT05"],
+  "select": "one_answer",
+  "answerNumbering": "uppercase_letters",
+  "shuffle": false,
+  "feedbacks": [],
+  "extra": {}
+}
+```
+
+### Deletar Pergunta
+**Método:** DELETE
+**Endpoint:** `/v3/question/:id`
+
+### Listar Respostas de Jogadores
+**Método:** GET
+**Endpoint:** `/v3/question/log?question=:id`
+
+### Criar Resposta de Jogador
+**Método:** POST
+**Endpoint:** `/v3/question/log`
+
+**Exemplo de Body:**
+```json
+{
+  "question": "64a5b2c2d8dcca49bcf7eb6e",
+  "answer": ["5"],
+  "player": "tom"
+}
+```
+
+### Deletar Resposta
+**Método:** DELETE
+**Endpoint:** `/v3/question/log/:id`
+
+## Tipos de Pergunta
+
+| Tipo | Descrição |
+|------|-----------|
+| `MULTIPLE_CHOICE` | Múltipla escolha (uma ou várias respostas) |
+| `TRUE_FALSE` | Verdadeiro ou Falso |
+| `ESSAY` | Dissertativa (resposta livre) |
+| `CROSSWORD` | Caça-palavras (mini game) |
+| `WORD_SEARCH` | Cruzadinha (mini game) |
+
+## Campos Importantes
+
+| Campo | Tipo | Descrição |
+|-------|------|-----------|
+| `quiz` | String | ID do quiz pai (vincula pergunta ao quiz) |
+| `type` | String | Tipo da pergunta (ver tabela acima) |
+| `question` | String | Texto da pergunta |
+| `grade` | Number | Peso/pontuação da pergunta |
+| `choices` | Array | Opções de resposta (ver estrutura abaixo) |
+| `select` | String | `one_answer` ou `multiple_answers` |
+| `shuffle` | Boolean | Embaralhar opções |
+| `techniques` | Array | IDs de técnicas de jogos vinculadas |
+
+### Estrutura de Choice (Opção de Resposta)
+
+```json
+{
+  "answer": "1",           // identificador único da opção
+  "label": "Funifier",     // texto exibido
+  "grade": 1,              // pontuação se escolhida (0 = errada)
+  "gradePercent": 100,     // percentual de acerto
+  "gradeCheck": true,      // indica se é resposta correta
+  "extra": {}              // metadados adicionais
+}
+```
+
+## Formatos de Apresentação
+
+Perguntas podem incluir conteúdo rico:
+- Texto com HTML
+- Imagens (campo `image`)
+- Vídeos e áudio (via `extra`)
+- Mini games (caça-palavras, cruzadinha)
+
+## Validações e Testes
+
+- [ ] Pergunta aparece na lista GET /v3/question
+- [ ] Resposta do jogador é registrada corretamente (POST /v3/question/log)
+- [ ] Grade é calculada com base na resposta
+- [ ] Opções de resposta estão corretas
+- [ ] Vinculação com quiz funciona (campo `quiz`)
+- [ ] Registro em lote funciona (POST /v3/question/log/bulk)

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

@@ -1,163 +1,163 @@
-# Quiz (Quiz)
-
-**Acesso Studio:** `/studio/quiz`
-**API Endpoint:** `/v3/quiz`
-
-## O que é
-
-Agrupamento de perguntas em formato de prova ou simulado. Permite criar provas compostas por perguntas, definir nota total, controlar tentativas e embaralhar questões para cada jogador. Os quizzes podem ser apresentados como mini games.
-
-## Quando usar
-
-- Para criar provas e avaliações
-- Para simulados com nota
-- Para treinamentos com pontuação
-- Para concursos de conhecimento
-
-## Dependências
-
-- **Question**: perguntas devem ser criadas para compor o quiz
-
-## Checklist de Configuração no Studio
-
-- [ ] Definir título e descrição do quiz
-- [ ] Definir nota total (grade)
-- [ ] Criar perguntas associadas ao quiz
-- [ ] Configurar embaralhamento (shuffle)
-- [ ] Definir se mostra nota antes de finalizar (showGradeBeforeFinish)
-- [ ] Configurar numeração das questões (questionNumbering)
-
-## API Endpoints
-
-### Listar Quizzes
-**Método:** GET
-**Endpoint:** `/v3/database/quiz`
-
-### Criar Quiz
-**Método:** POST
-**Endpoint:** `/v3/quiz`
-
-**Exemplo de Body:**
-```json
-{
-  "_id": "650c82fe832",
-  "title": "Funifier Exam",
-  "description": "Test your knowledge about the best gamification platform in the world.",
-  "grade": 10,
-  "i18n": {},
-  "extra": {},
-  "feedbacks": [],
-  "questionNumbering": "uppercase_letters",
-  "showGradeBeforeFinish": false,
-  "shuffle": false
-}
-```
-
-### Deletar Quiz
-**Método:** DELETE
-**Endpoint:** `/v3/quiz/:id`
-
-### Listar Perguntas de um Quiz
-**Método:** GET
-**Endpoint:** `/v3/quiz/:id/question`
-
-### Criar Pergunta para um Quiz
-**Método:** POST
-**Endpoint:** `/v3/question`
-
-**Exemplo de Body:**
-```json
-{
-  "quiz": "650c82fe832",
-  "type": "MULTIPLE_CHOICE",
-  "title": "Best Platform",
-  "question": "What is the best gamification platform?",
-  "grade": 1,
-  "choices": [
-    { "answer": "1", "label": "Funifier", "grade": 1, "extra": {}, "gradePercent": 100, "gradeCheck": true },
-    { "answer": "2", "label": "Points", "grade": 0, "extra": {}, "gradePercent": 0 },
-    { "answer": "3", "label": "Badges", "grade": 0, "extra": {}, "gradePercent": 0 },
-    { "answer": "4", "label": "Leaderboards", "grade": 0, "extra": {}, "gradePercent": 0 }
-  ],
-  "i18n": {},
-  "select": "one_answer",
-  "shuffle": false
-}
-```
-
-### Iniciar Quiz
-**Método:** POST
-**Endpoint:** `/v3/quiz/start`
-
-**Exemplo de Body:**
-```json
-{
-  "quiz": "650c82fe832",
-  "player": "tom"
-}
-```
-
-### Registrar Respostas em Lote
-**Método:** POST
-**Endpoint:** `/v3/question/log/bulk`
-
-**Exemplo de Body:**
-```json
-[
-  {
-    "quiz": "650c82fe832",
-    "quiz_log": "650dc6168325771ffaa94098",
-    "question": "650dc4d98325771ffaa93e5e",
-    "answer": ["1"],
-    "player": "tom"
-  }
-]
-```
-
-### Finalizar Quiz
-**Método:** POST
-**Endpoint:** `/v3/quiz/finish`
-
-**Exemplo de Body:**
-```json
-{
-  "quiz_log": "650dc6168325771ffaa94098"
-}
-```
-
-## Fluxo Completo do Quiz
-
-```
-1. Admin cria Quiz (POST /v3/quiz)
-2. Admin cria Questions vinculadas ao Quiz (POST /v3/question com "quiz": "quiz_id")
-3. Jogador inicia Quiz (POST /v3/quiz/start → retorna quiz_log_id)
-4. Jogador responde questões (POST /v3/question/log/bulk com quiz_log_id)
-5. Jogador finaliza Quiz (POST /v3/quiz/finish → calcula nota)
-```
-
-## Campos Importantes
-
-| Campo | Tipo | Descrição |
-|-------|------|-----------|
-| `grade` | Number | Nota total do quiz (ex: 10) |
-| `shuffle` | Boolean | Embaralhar ordem das perguntas |
-| `showGradeBeforeFinish` | Boolean | Mostrar nota parcial antes de finalizar |
-| `questionNumbering` | String | Formato numeração (`uppercase_letters`, `numbers`, etc.) |
-| `feedbacks` | Array | Mensagens de feedback por faixa de nota |
-
-## Apresentação como Mini Game
-
-Quizzes podem ser apresentados em formatos de mini games:
-- Corrida espacial
-- Quiz tradicional com timer
-- Formato personalizado via widget/frontend
-
-## Validações e Testes
-
-- [ ] Quiz aparece na lista GET /v3/database/quiz
-- [ ] Perguntas estão associadas ao quiz
-- [ ] Jogador consegue iniciar quiz (POST /v3/quiz/start)
-- [ ] Respostas são registradas corretamente (POST /v3/question/log/bulk)
-- [ ] Ao finalizar, nota é calculada (POST /v3/quiz/finish)
-- [ ] Embaralhamento funciona (se ativado)
-- [ ] Feedbacks aparecem conforme faixa de nota
+# Quiz (Quiz)
+
+**Acesso Studio:** `/studio/quiz`
+**API Endpoint:** `/v3/quiz`
+
+## O que é
+
+Agrupamento de perguntas em formato de prova ou simulado. Permite criar provas compostas por perguntas, definir nota total, controlar tentativas e embaralhar questões para cada jogador. Os quizzes podem ser apresentados como mini games.
+
+## Quando usar
+
+- Para criar provas e avaliações
+- Para simulados com nota
+- Para treinamentos com pontuação
+- Para concursos de conhecimento
+
+## Dependências
+
+- **Question**: perguntas devem ser criadas para compor o quiz
+
+## Checklist de Configuração no Studio
+
+- [ ] Definir título e descrição do quiz
+- [ ] Definir nota total (grade)
+- [ ] Criar perguntas associadas ao quiz
+- [ ] Configurar embaralhamento (shuffle)
+- [ ] Definir se mostra nota antes de finalizar (showGradeBeforeFinish)
+- [ ] Configurar numeração das questões (questionNumbering)
+
+## API Endpoints
+
+### Listar Quizzes
+**Método:** GET
+**Endpoint:** `/v3/database/quiz`
+
+### Criar Quiz
+**Método:** POST
+**Endpoint:** `/v3/quiz`
+
+**Exemplo de Body:**
+```json
+{
+  "_id": "650c82fe832",
+  "title": "Funifier Exam",
+  "description": "Test your knowledge about the best gamification platform in the world.",
+  "grade": 10,
+  "i18n": {},
+  "extra": {},
+  "feedbacks": [],
+  "questionNumbering": "uppercase_letters",
+  "showGradeBeforeFinish": false,
+  "shuffle": false
+}
+```
+
+### Deletar Quiz
+**Método:** DELETE
+**Endpoint:** `/v3/quiz/:id`
+
+### Listar Perguntas de um Quiz
+**Método:** GET
+**Endpoint:** `/v3/quiz/:id/question`
+
+### Criar Pergunta para um Quiz
+**Método:** POST
+**Endpoint:** `/v3/question`
+
+**Exemplo de Body:**
+```json
+{
+  "quiz": "650c82fe832",
+  "type": "MULTIPLE_CHOICE",
+  "title": "Best Platform",
+  "question": "What is the best gamification platform?",
+  "grade": 1,
+  "choices": [
+    { "answer": "1", "label": "Funifier", "grade": 1, "extra": {}, "gradePercent": 100, "gradeCheck": true },
+    { "answer": "2", "label": "Points", "grade": 0, "extra": {}, "gradePercent": 0 },
+    { "answer": "3", "label": "Badges", "grade": 0, "extra": {}, "gradePercent": 0 },
+    { "answer": "4", "label": "Leaderboards", "grade": 0, "extra": {}, "gradePercent": 0 }
+  ],
+  "i18n": {},
+  "select": "one_answer",
+  "shuffle": false
+}
+```
+
+### Iniciar Quiz
+**Método:** POST
+**Endpoint:** `/v3/quiz/start`
+
+**Exemplo de Body:**
+```json
+{
+  "quiz": "650c82fe832",
+  "player": "tom"
+}
+```
+
+### Registrar Respostas em Lote
+**Método:** POST
+**Endpoint:** `/v3/question/log/bulk`
+
+**Exemplo de Body:**
+```json
+[
+  {
+    "quiz": "650c82fe832",
+    "quiz_log": "650dc6168325771ffaa94098",
+    "question": "650dc4d98325771ffaa93e5e",
+    "answer": ["1"],
+    "player": "tom"
+  }
+]
+```
+
+### Finalizar Quiz
+**Método:** POST
+**Endpoint:** `/v3/quiz/finish`
+
+**Exemplo de Body:**
+```json
+{
+  "quiz_log": "650dc6168325771ffaa94098"
+}
+```
+
+## Fluxo Completo do Quiz
+
+```
+1. Admin cria Quiz (POST /v3/quiz)
+2. Admin cria Questions vinculadas ao Quiz (POST /v3/question com "quiz": "quiz_id")
+3. Jogador inicia Quiz (POST /v3/quiz/start → retorna quiz_log_id)
+4. Jogador responde questões (POST /v3/question/log/bulk com quiz_log_id)
+5. Jogador finaliza Quiz (POST /v3/quiz/finish → calcula nota)
+```
+
+## Campos Importantes
+
+| Campo | Tipo | Descrição |
+|-------|------|-----------|
+| `grade` | Number | Nota total do quiz (ex: 10) |
+| `shuffle` | Boolean | Embaralhar ordem das perguntas |
+| `showGradeBeforeFinish` | Boolean | Mostrar nota parcial antes de finalizar |
+| `questionNumbering` | String | Formato numeração (`uppercase_letters`, `numbers`, etc.) |
+| `feedbacks` | Array | Mensagens de feedback por faixa de nota |
+
+## Apresentação como Mini Game
+
+Quizzes podem ser apresentados em formatos de mini games:
+- Corrida espacial
+- Quiz tradicional com timer
+- Formato personalizado via widget/frontend
+
+## Validações e Testes
+
+- [ ] Quiz aparece na lista GET /v3/database/quiz
+- [ ] Perguntas estão associadas ao quiz
+- [ ] Jogador consegue iniciar quiz (POST /v3/quiz/start)
+- [ ] Respostas são registradas corretamente (POST /v3/question/log/bulk)
+- [ ] Ao finalizar, nota é calculada (POST /v3/quiz/finish)
+- [ ] Embaralhamento funciona (se ativado)
+- [ ] Feedbacks aparecem conforme faixa de nota