funifier-mcp 0.2.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/`.

package/README.md

@@ -1,4 +1,4 @@
-# funifier-mcp
+# @funifier-ai
 
 Funifier AI toolkit — API client, MCP server, and AI assistant skills for the [Funifier](https://funifier.com) gamification platform.
 
@@ -8,48 +8,159 @@ Funifier AI toolkit — API client, MCP server, and AI assistant skills for the
 |-----------|-------------|
 | **API Client** | Pure Node.js client for the Funifier REST API (80+ methods, 18 resource types) |
 | **MCP Server** | Model Context Protocol server exposing 8 tools + 3 prompts + documentation resources |
-| **Skills** | 15 guided workflows for Claude Code, Codex, OpenCode, Cursor, Copilot, and Antigravity |
+| **Skills** | 15 guided workflows for Claude Code, Codex, Copilot, Continue, and Cursor |
 | **Instructions** | Platform-specific instruction files (AGENTS.md, copilot-instructions.md, cursor rules) |
-| **Init CLI** | `npx funifier-mcp init` — interactive setup for every supported platform |
 
 ## Quick Start
 
+1. **Install:**
+
+```bash
+npm install @funifier-ai
+```
+
+2. **Choose your platform** and follow setup instructions:
+
+- [Claude Code](#claude-code) — Claude's official IDE and CLI
+- [Codex CLI](#codex-cli-and-opencode) — Codex command-line agent
+- [OpenCode](#codex-cli-and-opencode) — Open-source agent framework
+- [GitHub Copilot](#github-copilot) — VS Code, JetBrains, GitHub.com
+- [Continue IDE](#continue-ide) — Open-source IDE extension
+- [Cursor IDE](#cursor-ide) — AI-native code editor
+
+For detailed setup instructions, see:
+- **[docs/INSTALL_EXAMPLES.md](docs/INSTALL_EXAMPLES.md)** — Real-world examples
+- **[docs/PLATFORM_SETUP.md](docs/PLATFORM_SETUP.md)** — Full platform guide
+- **[docs/](docs/)** — Complete documentation index
+
+## Installation
+
+### From npm (published)
+
 ```bash
-# 1. Create (or cd into) your project
-npm init -y
+npm install @funifier-ai
+```
 
-# 2. Install
-npm install funifier-mcp
+### Local development (before publishing)
 
-# 3. Run interactive setup
-npx funifier-mcp init
+**Automated setup (recommended):**
+
+From **funifier-ai directory**, run:
+
+```bash
+node scripts/install-local.js /path/to/my-project
+# or relative path:
+node scripts/install-local.js ../my-project
+# or install in current directory:
+node scripts/install-local.js
 ```
 
-`init` asks which platforms you use, optionally collects Funifier credentials, then:
+The script will:
+1. Ask which platforms you're using (Claude Code, Codex, OpenCode, Copilot, Cursor, or all/none)
+2. Build Funifier AI
+3. Create npm link
+4. Copy only the files you need for your selected platforms
 
-- Copies the skill/instruction files each platform expects (`.claude/skills/`, `AGENTS.md`, `.cursor/rules/`, etc.)
-- Writes the correct MCP server config for each platform (`.mcp.json`, `.codex/config.toml`, `opencode.json`, `.cursor/mcp.json`, `.antigravity/mcp_config.json`)
-- Writes `funifier.json` with your credentials (and adds it to `.gitignore`), or `funifier.json.example` if you skip credentials
-- Prompts before overwriting anything that already exists
+Changes to funifier-ai appear immediately in your project.
 
-### Supported platforms
+**Manual setup:**
 
-- **Claude Code** — Anthropic's official CLI/IDE
-- **Codex CLI** — OpenAI's command-line agent
-- **OpenCode** — open-source agent framework
-- **Cursor IDE** — AI-native code editor
-- **GitHub Copilot** — VS Code, JetBrains, GitHub.com
-- **Google Antigravity** — Gemini-based desktop agent
+```bash
+# In funifier-ai directory
+npm run build && npm run bundle && npm link
 
-> Antigravity reads its MCP config from `~/.gemini/antigravity/mcp_config.json`. `init` writes a project-level snippet to `.antigravity/mcp_config.json` and prints the global path so you can merge it in.
+# In your project
+npm link @funifier-ai
+```
 
-## CLI
+**Direct path (copy mode):**
 
 ```bash
-funifier-mcp              # Start the MCP server over stdio (used by MCP clients)
-funifier-mcp init         # Interactive setup
-funifier-mcp --version
-funifier-mcp --help
+npm install /path/to/funifier-ai
+# or
+npm install file:../funifier-ai
+```
+
+See [docs/PLATFORM_SETUP.md](docs/PLATFORM_SETUP.md#local-development-setup) for details.
+
+## Quick Verification
+
+After local installation, verify everything is working:
+
+```bash
+# From your project directory
+node ../funifier-ai/scripts/test-local.js
+```
+
+This checks:
+- ✓ Symlink is set up correctly
+- ✓ Built files exist (dist/)
+- ✓ Instruction files copied
+- ✓ Can import the package
+- ✓ API client works (if credentials set)
+
+For detailed information on how local testing works, see [docs/LOCAL_TESTING.md](docs/LOCAL_TESTING.md).
+
+If any check fails, see [docs/MCP_SETUP.md](docs/MCP_SETUP.md) for troubleshooting.
+
+---
+
+## MCP Server Setup
+
+### With Claude Code
+
+Add to your `.mcp.json` (project or global `~/.claude/.mcp.json`):
+
+```json
+{
+  "mcpServers": {
+    "funifier": {
+      "command": "node",
+      "args": ["node_modules/@funifier-ai/dist/mcp/index.js"],
+      "env": {
+        "FUNIFIER_API_KEY": "your-api-key",
+        "FUNIFIER_SECRET_KEY": "your-secret-key",
+        "FUNIFIER_SERVER_URL": "https://your-instance.funifier.com"
+      }
+    }
+  }
+}
+```
+
+Or place a `funifier.json` in your project root:
+
+```json
+{
+  "apiKey": "your-api-key",
+  "secretKey": "your-secret-key",
+  "serverUrl": "https://your-instance.funifier.com"
+}
+```
+
+### With Claude Desktop
+
+```json
+{
+  "mcpServers": {
+    "funifier": {
+      "command": "npx",
+      "args": ["@funifier-ai"],
+      "env": {
+        "FUNIFIER_API_KEY": "your-api-key",
+        "FUNIFIER_SECRET_KEY": "your-secret-key",
+        "FUNIFIER_SERVER_URL": "https://your-instance.funifier.com"
+      }
+    }
+  }
+}
+```
+
+### Runtime connection
+
+If no config is provided at startup, use the `funifier_connect` tool to connect:
+
+```
+funifier_connect({ apiKey: "...", secretKey: "...", serverUrl: "https://..." })
 ```
 
 ## MCP Tools
@@ -72,7 +183,7 @@ trigger, scheduler, aggregate, websocket, widget, custom-page, public-endpoint,
 ## API Client (library usage)
 
 ```typescript
-import { createAPIClient } from "funifier-mcp";
+import { createAPIClient } from "@funifier-ai";
 
 const api = createAPIClient({
   apiKey: "your-api-key",
@@ -80,44 +191,91 @@ const api = createAPIClient({
   serverUrl: "https://your-instance.funifier.com",
 });
 
+// List all triggers
 const triggers = await api.listTriggers();
+
+// Execute an aggregate
 const result = await api.executeAggregate("my-aggregate-id", {});
+
+// Query any collection
 const players = await api.queryCollection("player", { active: true }, { limit: 10 });
 ```
 
-## Manual MCP Setup (if you skip `init`)
+## Skills and Instructions
 
-Point your MCP client at the bundled server:
+This package includes generated instruction files for multiple platforms. Each provides guided workflows, code quality standards, MCP tool routing, and documentation search.
 
-```json
-{
-  "mcpServers": {
-    "funifier": {
-      "command": "npx",
-      "args": ["funifier-mcp"],
-      "env": {
-        "FUNIFIER_API_KEY": "your-api-key",
-        "FUNIFIER_SECRET_KEY": "your-secret-key",
-        "FUNIFIER_SERVER_URL": "https://your-instance.funifier.com"
-      }
-    }
-  }
-}
+### Claude Code
+
+Install skills to your project:
+
+```bash
+cp -r node_modules/@funifier-ai/skills/* .claude/skills/
 ```
 
-Or drop a `funifier.json` in your project root and the server will pick it up automatically:
+Invoke any skill with `/funifier-<name>`:
 
-```json
-{
-  "apiKey": "your-api-key",
-  "secretKey": "your-secret-key",
-  "serverUrl": "https://your-instance.funifier.com"
-}
+```
+/funifier-create-trigger
+/funifier-debug
+/funifier-help
 ```
 
-If no config is provided at startup, call the `funifier_connect` tool at runtime.
+### Codex CLI and OpenCode
+
+The generated `AGENTS.md` file provides instructions for Codex, OpenCode, and any agent that reads AGENTS.md.
+
+**Codex CLI:**
+
+```bash
+cp node_modules/@funifier-ai/AGENTS.md .
+codex "Create a trigger for player registration"
+```
+
+**OpenCode:**
+
+```bash
+cp node_modules/@funifier-ai/AGENTS.md .
+# Add to .opencode.json:
+# { "instructions": { "file": "./AGENTS.md" } }
+opencode "Debug my scheduler"
+```
+
+See [PLATFORM_SETUP.md](docs/PLATFORM_SETUP.md) for full configuration details.
+
+### GitHub Copilot
+
+```bash
+mkdir -p .github
+cp node_modules/@funifier-ai/.github/copilot-instructions.md .github/
+```
+
+Copilot automatically applies `.github/copilot-instructions.md` to code suggestions, chat, and PR reviews.
+
+### Continue IDE
+
+```bash
+mkdir -p .github
+cp node_modules/@funifier-ai/.github/copilot-instructions.md .github/
+# Configure ~/.continue/config.json with customInstructions and MCP
+```
 
-## Available Workflows
+Continue (VS Code / JetBrains) supports full MCP integration. See [PLATFORM_SETUP.md](docs/PLATFORM_SETUP.md) for configuration.
+
+### Cursor IDE
+
+```bash
+mkdir -p .cursor/rules
+cp node_modules/@funifier-ai/.cursor/rules/funifier.mdc .cursor/rules/
+```
+
+Cursor automatically discovers and applies `.mdc` files in `.cursor/rules/` to all code generation and completions.
+
+---
+
+### Available Workflows
+
+Each platform above provides access to these guided workflows:
 
 | Skill | Description |
 |-------|-------------|
@@ -136,7 +294,34 @@ If no config is provided at startup, call the `funifier_connect` tool at runtime
 | `funifier-create-virtual-good` | Create virtual stores |
 | `funifier-implement-frontend` | Build frontend consuming Funifier API |
 
-In Claude Code, invoke any skill with `/funifier-<name>` (e.g. `/funifier-help`).
+## Generated Files
+
+When you install `@funifier-ai`, the package includes pre-generated instruction and skill files:
+
+| File | Platforms | Purpose |
+|------|-----------|---------|
+| `skills/funifier-*/SKILL.md` | Claude Code | Guided workflows with system prompt, doc search, and steps |
+| `AGENTS.md` | Codex, OpenCode | Agent routing, MCP tools, and skill index |
+| `.github/copilot-instructions.md` | Copilot, Continue | Code quality standards and skill routing |
+| `.cursor/rules/funifier.mdc` | Cursor | Development rules with YAML frontmatter |
+
+All files embed:
+- **Senior developer persona** (SOLID, DRY, KISS, YAGNI)
+- **Skill routing** (which skill to use for each task)
+- **MCP tool reference** (if server is configured)
+- **Lexical search command** (to find relevant docs efficiently)
+
+---
+
+## Documentation
+
+- **[docs/README.md](docs/)** — Complete documentation index
+- **[docs/PLATFORM_SETUP.md](docs/PLATFORM_SETUP.md)** — Detailed setup for all platforms
+- **[docs/QUICK_REFERENCE.md](docs/QUICK_REFERENCE.md)** — Copy-paste setup commands
+- **[docs/INSTALL_EXAMPLES.md](docs/INSTALL_EXAMPLES.md)** — Real-world scenarios
+- **[docs/MCP_SETUP.md](docs/MCP_SETUP.md)** — MCP configuration and troubleshooting
+
+---
 
 ## Configuration
 
@@ -149,34 +334,18 @@ In Claude Code, invoke any skill with `/funifier-<name>` (e.g. `/funifier-help`)
 | `FUNIFIER_SERVER_URL` | Base URL of your Funifier instance |
 | `FUNIFIER_DOCS_PATH` | Path to documentation files (optional) |
 
-Resolution order: `funifier.json` in cwd → environment variables → `funifier_connect` tool at runtime.
-
-## Local development
-
-```bash
-git clone https://github.com/funifierinc/funifier-mcp.git
-cd funifier-mcp
-npm install
-npm run build         # tsc → dist/
-npm run bundle        # build + esbuild single-file bundle
-npm test              # vitest
-```
+### funifier.json
 
-To test `init` against a scratch project:
+Place in your project root for automatic configuration:
 
-```bash
-npm link
-cd /tmp/scratch && npm init -y && npm link funifier-mcp
-npx funifier-mcp init
+```json
+{
+  "apiKey": "your-api-key",
+  "secretKey": "your-secret-key",
+  "serverUrl": "https://your-instance.funifier.com"
+}
 ```
 
-## Documentation
-
-- **[docs/PLATFORM_SETUP.md](docs/PLATFORM_SETUP.md)** — Detailed setup for all platforms
-- **[docs/QUICK_REFERENCE.md](docs/QUICK_REFERENCE.md)** — Copy-paste setup commands
-- **[docs/INSTALL_EXAMPLES.md](docs/INSTALL_EXAMPLES.md)** — Real-world scenarios
-- **[docs/MCP_SETUP.md](docs/MCP_SETUP.md)** — MCP configuration and troubleshooting
-
 ## License
 
 MIT