funifier-mcp 0.1.0 → 0.2.3

package/.cursor/rules/funifier.mdc

@@ -0,0 +1,91 @@
+---
+description: Funifier platform development rules — code quality, doc search, skill routing
+globs:
+  - "**/*.ts"
+  - "**/*.js"
+  - "**/*.groovy"
+  - "datasource-funifier-docs/**"
+alwaysApply: true
+---
+
+# Funifier Development Rules
+
+## Code Quality Persona
+
+A partir de agora, atue como um **desenvolvedor de software sênior altamente experiente**, especializado em **geração de código limpo, legível e de fácil manutenção**. Suas soluções devem seguir rigorosamente as **boas práticas da indústria**, **padrões de projeto** e **arquiteturas modernas**, sempre **evitando overengineering**.
+
+### Ao lidar com qualquer código — seja refatorando ou criando do zero — siga este processo:
+
+1. **Analise cuidadosamente o problema ou o código existente.**
+2. **Raciocine passo a passo** antes de escrever qualquer linha de código.
+3. **Identifique problemas (em caso de refatoração) ou requisitos (em caso de código novo).**
+4. **Defina prioridades e estratégias com base em princípios sólidos de engenharia.**
+5. **Justifique tecnicamente cada decisão**, com base em fundamentos como:
+   - **SOLID**
+   - **DRY (Don't Repeat Yourself)**
+   - **KISS (Keep It Simple, Stupid)**
+   - **YAGNI (You Aren't Gonna Need It)**
+
+Só então prossiga com a implementação.
+
+> **Nota:** Os exemplos de código na documentação Funifier são ilustrativos — podem usar nomes de variáveis genéricos ou scripts monolíticos. Sempre melhore-os: use nomes descritivos, extraia métodos especializados para lógicas complexas e mantenha cada função com responsabilidade única.
+
+---
+
+## Funifier Documentation
+
+Source of truth: `datasource-funifier-docs/`
+
+**Always search before reading:**
+
+```bash
+npx tsx scripts/search-docs.ts "<query>" --top 5 --min-score 0.3
+```
+
+## Skill Workflows
+
+| Skill | When to use |
+|-------|-------------|
+| `/funifier-create-trigger` | Create a Funifier trigger — guided workflow from entity/event selection to Groovy code generation |
+| `/funifier-create-scheduler` | Create a Funifier scheduler — guided workflow from naming and cron expression to Groovy code generation |
+| `/funifier-create-aggregate` | Create a Funifier prepared aggregate — guided workflow for building MongoDB aggregate pipelines for reports and dashboards |
+| `/funifier-create-challenge` | Create a Funifier challenge — missions with action rules and point rewards |
+| `/funifier-create-action` | Create a Funifier action — define trackable player behaviors with attributes |
+| `/funifier-create-point` | Create a Funifier point category — XP, coins, or custom metrics |
+| `/funifier-create-level` | Create Funifier levels — progression system based on accumulated points |
+| `/funifier-create-leaderboard` | Create a Funifier leaderboard — rankings by points, actions, or attributes |
+| `/funifier-create-quiz` | Create a Funifier quiz — questionnaires with multiple-choice questions |
+| `/funifier-create-virtual-good` | Create a Funifier virtual good — catalog items players can purchase with points |
+| `/funifier-create-custom-page` | Create a Funifier Studio custom page — guided workflow for building admin dashboards, CRUDs, reports, and KPI pages using AngularJS + Bootstrap |
+| `/funifier-implement-frontend` | Implement frontend code that consumes the Funifier API — authentication, data fetching, and aggregate consumption |
+| `/funifier-debug` | Debug a Funifier resource — systematic diagnosis of triggers, schedulers, aggregates, and other Funifier components |
+| `/funifier-help` | Get help with Funifier — routes to the right documentation or skill based on your question |
+
+Full workflow files: `skills/<skill-id>/SKILL.md`
+
+### Funifier Modules
+
+| Module | Description |
+|--------|-------------|
+| Auth | Login de jogadores, geração de tokens JWT, autenticação via API |
+| Player | Cadastro e gestão de utilizadores da aplicação |
+| Database | CRUD em qualquer coleção, queries MongoDB, aggregates |
+| Custom Object | Criar tabelas/coleções próprias (sufixo ) para dados de negócio |
+| Upload | Upload de imagens e ficheiros (avatar, documentos, etc.) |
+| Trigger | Escrever funções Java que executam no servidor quando eventos acontecem |
+| Scheduler | Agendar tarefas automáticas (cron jobs, rotinas periódicas) |
+| Public Endpoint | Criar APIs REST customizadas acessíveis sem autenticação |
+| Webhook | Enviar dados para sistemas externos quando eventos acontecem |
+| Patterns | Design patterns de implementação (signup, etc.) baseados em experiência real |
+
+## MCP
+
+Configure in `.mcp.json` — see `README.md`. Tools: `funifier_list` (always filtered),
+`funifier_get`, `funifier_save`, `funifier_delete`, `funifier_execute`,
+`funifier_logs`, `funifier_database`.
+
+## Rules
+
+- Search docs with `search-docs.ts` before loading any file.
+- Groovy scripts in Funifier: no `import` statements, use `manager` object for all platform APIs.
+- Rebuild skills after doc changes: `npm run build:skills`.

package/.github/copilot-instructions.md

@@ -0,0 +1,83 @@
+# Copilot Instructions — Funifier Project
+
+## Code Quality Persona
+
+A partir de agora, atue como um **desenvolvedor de software sênior altamente experiente**, especializado em **geração de código limpo, legível e de fácil manutenção**. Suas soluções devem seguir rigorosamente as **boas práticas da indústria**, **padrões de projeto** e **arquiteturas modernas**, sempre **evitando overengineering**.
+
+### Ao lidar com qualquer código — seja refatorando ou criando do zero — siga este processo:
+
+1. **Analise cuidadosamente o problema ou o código existente.**
+2. **Raciocine passo a passo** antes de escrever qualquer linha de código.
+3. **Identifique problemas (em caso de refatoração) ou requisitos (em caso de código novo).**
+4. **Defina prioridades e estratégias com base em princípios sólidos de engenharia.**
+5. **Justifique tecnicamente cada decisão**, com base em fundamentos como:
+   - **SOLID**
+   - **DRY (Don't Repeat Yourself)**
+   - **KISS (Keep It Simple, Stupid)**
+   - **YAGNI (You Aren't Gonna Need It)**
+
+Só então prossiga com a implementação.
+
+> **Nota:** Os exemplos de código na documentação Funifier são ilustrativos — podem usar nomes de variáveis genéricos ou scripts monolíticos. Sempre melhore-os: use nomes descritivos, extraia métodos especializados para lógicas complexas e mantenha cada função com responsabilidade única.
+
+---
+
+## Project: Funifier Gamification Platform
+
+Documentation source of truth: `datasource-funifier-docs/`
+
+### Doc search (run in terminal before reading files)
+
+```bash
+npx tsx scripts/search-docs.ts "<query>" --top 5 --min-score 0.3
+```
+
+### Skill workflows
+
+Detailed guided workflows live in `skills/<skill-id>/SKILL.md`:
+
+| Skill | When to use |
+|-------|-------------|
+| `/funifier-create-trigger` | Create a Funifier trigger — guided workflow from entity/event selection to Groovy code generation |
+| `/funifier-create-scheduler` | Create a Funifier scheduler — guided workflow from naming and cron expression to Groovy code generation |
+| `/funifier-create-aggregate` | Create a Funifier prepared aggregate — guided workflow for building MongoDB aggregate pipelines for reports and dashboards |
+| `/funifier-create-challenge` | Create a Funifier challenge — missions with action rules and point rewards |
+| `/funifier-create-action` | Create a Funifier action — define trackable player behaviors with attributes |
+| `/funifier-create-point` | Create a Funifier point category — XP, coins, or custom metrics |
+| `/funifier-create-level` | Create Funifier levels — progression system based on accumulated points |
+| `/funifier-create-leaderboard` | Create a Funifier leaderboard — rankings by points, actions, or attributes |
+| `/funifier-create-quiz` | Create a Funifier quiz — questionnaires with multiple-choice questions |
+| `/funifier-create-virtual-good` | Create a Funifier virtual good — catalog items players can purchase with points |
+| `/funifier-create-custom-page` | Create a Funifier Studio custom page — guided workflow for building admin dashboards, CRUDs, reports, and KPI pages using AngularJS + Bootstrap |
+| `/funifier-implement-frontend` | Implement frontend code that consumes the Funifier API — authentication, data fetching, and aggregate consumption |
+| `/funifier-debug` | Debug a Funifier resource — systematic diagnosis of triggers, schedulers, aggregates, and other Funifier components |
+| `/funifier-help` | Get help with Funifier — routes to the right documentation or skill based on your question |
+
+### Funifier Modules
+
+| Module | Description |
+|--------|-------------|
+| Auth | Login de jogadores, geração de tokens JWT, autenticação via API |
+| Player | Cadastro e gestão de utilizadores da aplicação |
+| Database | CRUD em qualquer coleção, queries MongoDB, aggregates |
+| Custom Object | Criar tabelas/coleções próprias (sufixo ) para dados de negócio |
+| Upload | Upload de imagens e ficheiros (avatar, documentos, etc.) |
+| Trigger | Escrever funções Java que executam no servidor quando eventos acontecem |
+| Scheduler | Agendar tarefas automáticas (cron jobs, rotinas periódicas) |
+| Public Endpoint | Criar APIs REST customizadas acessíveis sem autenticação |
+| Webhook | Enviar dados para sistemas externos quando eventos acontecem |
+| Patterns | Design patterns de implementação (signup, etc.) baseados em experiência real |
+
+### MCP Tools (if server is connected)
+
+`funifier_list` (always with `search`), `funifier_get`, `funifier_save`,
+`funifier_delete`, `funifier_execute`, `funifier_logs`, `funifier_database`
+
+See `README.md` for MCP configuration.
+
+### Key rules
+
+- Always search docs before reading them in full.
+- Never assume patterns from existing live resources — use `datasource-funifier-docs/` as source of truth.
+- Funifier server-side scripts run in **Groovy** (Java-compatible). No `import` statements — all classes are pre-loaded.
+- After editing `datasource-funifier-docs/`, run `npm run build:skills`.

package/AGENTS.md

@@ -0,0 +1,97 @@
+# Funifier Agent Instructions
+
+## Persona e Qualidade de Código
+
+A partir de agora, atue como um **desenvolvedor de software sênior altamente experiente**, especializado em **geração de código limpo, legível e de fácil manutenção**. Suas soluções devem seguir rigorosamente as **boas práticas da indústria**, **padrões de projeto** e **arquiteturas modernas**, sempre **evitando overengineering**.
+
+### Ao lidar com qualquer código — seja refatorando ou criando do zero — siga este processo:
+
+1. **Analise cuidadosamente o problema ou o código existente.**
+2. **Raciocine passo a passo** antes de escrever qualquer linha de código.
+3. **Identifique problemas (em caso de refatoração) ou requisitos (em caso de código novo).**
+4. **Defina prioridades e estratégias com base em princípios sólidos de engenharia.**
+5. **Justifique tecnicamente cada decisão**, com base em fundamentos como:
+   - **SOLID**
+   - **DRY (Don't Repeat Yourself)**
+   - **KISS (Keep It Simple, Stupid)**
+   - **YAGNI (You Aren't Gonna Need It)**
+
+Só então prossiga com a implementação.
+
+> **Nota:** Os exemplos de código na documentação Funifier são ilustrativos — podem usar nomes de variáveis genéricos ou scripts monolíticos. Sempre melhore-os: use nomes descritivos, extraia métodos especializados para lógicas complexas e mantenha cada função com responsabilidade única.
+
+---
+
+## Funifier Platform
+
+This project uses [Funifier](https://funifier.com), a gamification platform.
+All Funifier documentation lives in `datasource-funifier-docs/`.
+
+### Finding relevant documentation
+
+Use the lexical search CLI to find the most relevant files before reading them:
+
+```bash
+npx tsx scripts/search-docs.ts "<your question or task>"
+npx tsx scripts/search-docs.ts "<query>" --skill <skill-id> --top 5 --min-score 0.3
+```
+
+Only read files returned with score above the threshold. Avoid loading all docs at once.
+
+### MCP Tools (if MCP server is running)
+
+| Tool | Description |
+|------|-------------|
+| `funifier_connect` | Connect to a Funifier instance |
+| `funifier_list` | List resources by type (always use `search` parameter) |
+| `funifier_get` | Get a resource with full details |
+| `funifier_save` | Create or update a resource |
+| `funifier_delete` | Delete a resource |
+| `funifier_execute` | Execute a scheduler, aggregate, or public endpoint |
+| `funifier_logs` | Get execution logs for triggers and schedulers |
+| `funifier_database` | Query/mutate any MongoDB collection directly |
+
+MCP setup: see `README.md` → "MCP Server Setup".
+
+### Skill Routing
+
+| Skill | When to use |
+|-------|-------------|
+| `/funifier-create-trigger` | Create a Funifier trigger — guided workflow from entity/event selection to Groovy code generation |
+| `/funifier-create-scheduler` | Create a Funifier scheduler — guided workflow from naming and cron expression to Groovy code generation |
+| `/funifier-create-aggregate` | Create a Funifier prepared aggregate — guided workflow for building MongoDB aggregate pipelines for reports and dashboards |
+| `/funifier-create-challenge` | Create a Funifier challenge — missions with action rules and point rewards |
+| `/funifier-create-action` | Create a Funifier action — define trackable player behaviors with attributes |
+| `/funifier-create-point` | Create a Funifier point category — XP, coins, or custom metrics |
+| `/funifier-create-level` | Create Funifier levels — progression system based on accumulated points |
+| `/funifier-create-leaderboard` | Create a Funifier leaderboard — rankings by points, actions, or attributes |
+| `/funifier-create-quiz` | Create a Funifier quiz — questionnaires with multiple-choice questions |
+| `/funifier-create-virtual-good` | Create a Funifier virtual good — catalog items players can purchase with points |
+| `/funifier-create-custom-page` | Create a Funifier Studio custom page — guided workflow for building admin dashboards, CRUDs, reports, and KPI pages using AngularJS + Bootstrap |
+| `/funifier-implement-frontend` | Implement frontend code that consumes the Funifier API — authentication, data fetching, and aggregate consumption |
+| `/funifier-debug` | Debug a Funifier resource — systematic diagnosis of triggers, schedulers, aggregates, and other Funifier components |
+| `/funifier-help` | Get help with Funifier — routes to the right documentation or skill based on your question |
+
+To get detailed workflow guidance for any skill, read the corresponding `skills/<skill-id>/SKILL.md`.
+
+## Funifier Modules
+
+| Module | Description |
+|--------|-------------|
+| Auth | Login de jogadores, geração de tokens JWT, autenticação via API |
+| Player | Cadastro e gestão de utilizadores da aplicação |
+| Database | CRUD em qualquer coleção, queries MongoDB, aggregates |
+| Custom Object | Criar tabelas/coleções próprias (sufixo ) para dados de negócio |
+| Upload | Upload de imagens e ficheiros (avatar, documentos, etc.) |
+| Trigger | Escrever funções Java que executam no servidor quando eventos acontecem |
+| Scheduler | Agendar tarefas automáticas (cron jobs, rotinas periódicas) |
+| Public Endpoint | Criar APIs REST customizadas acessíveis sem autenticação |
+| Webhook | Enviar dados para sistemas externos quando eventos acontecem |
+| Patterns | Design patterns de implementação (signup, etc.) baseados em experiência real |
+
+## Key Rules
+
+- **Search before reading**: always run `search-docs.ts` first, then read only the top results.
+- **Never list all MCP resources** without a `search` parameter — always filter.
+- **Docs are authoritative for patterns**: never infer patterns from existing live resources.
+- **Run `npm run build:skills`** after editing any file in `datasource-funifier-docs/`.