Skip to content

Commit 581e055

Browse files
KooshaParidiegosouzapw
authored andcommitted
docs(gamification): align XP Rewards table with code (#12501)
The XP Rewards table in docs/frameworks/GAMIFICATION.md contained 12 entries but the canonical XP_REWARDS Record in src/lib/gamification/xp.ts has 10. Discrepancies: - 3 phantom entries not in code: badge_earned, streak_milestone, referral - 3 code entries missing from docs: model_switch, streak_bonus, badge_unlock - Wrong XP values for token_share (5 -> 1) and daily_login (3 -> 5) Code is the source of truth (it's what actually awards XP). Aligned the docs table to match code exactly with matching keys, values, and descriptions extracted from the TS interface comments. Fixes #12501 (cherry picked from commit 49f2749)
1 parent c3945a7 commit 581e055

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

docs/frameworks/GAMIFICATION.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -236,20 +236,18 @@ xp_for_level(n) = floor(100 * n^1.5)
236236

237237
### XP Rewards
238238

239-
| Action | XP | Description |
240-
| ------------------ | --- | --------------------------------------------------------- |
241-
| `request` | 1 | Per successful LLM request |
242-
| `provider_switch` | 5 | Switching to a different provider |
243-
| `combo_create` | 10 | Creating a new combo configuration |
244-
| `combo_use` | 2 | Using a combo (per target hit) |
245-
| `badge_earned` | 25 | Earning any badge |
246-
| `streak_milestone` | 15 | Reaching a streak milestone (7, 14, 30, 60, 90, 180, 365) |
247-
| `referral` | 50 | Successfully referring a new user |
248-
| `token_share` | 5 | Sharing tokens with another user |
249-
| `daily_login` | 3 | First request of the day |
250-
| `model_diversity` | 3 | Using a model not used in the past 7 days |
251-
| `compression_use` | 2 | Using prompt compression |
252-
| `skill_use` | 2 | Executing a skill via MCP |
239+
| Action | XP | Description |
240+
| ----------------- | --- | -------------------------------------------------------- |
241+
| `request` | 1 | Per API request routed through OmniRoute |
242+
| `provider_switch` | 5 | Switching to a different provider |
243+
| `model_switch` | 3 | Switching to a different model |
244+
| `combo_create` | 10 | Creating a new combo |
245+
| `combo_use` | 2 | Using a combo for a request |
246+
| `token_share` | 1 | Per 1 000 tokens shared with another user |
247+
| `invite_redeem` | 50 | Redeeming an invite code |
248+
| `daily_login` | 5 | Daily active usage (once per day) |
249+
| `streak_bonus` | 2 | Per consecutive streak day (multiplied by streak length) |
250+
| `badge_unlock` | 10 | Unlocking a badge |
253251

254252
### Award Flow
255253

@@ -812,7 +810,7 @@ Route → CORS preflight → Body validation (Zod) → Auth (extractApiKey)
812810
Registered in `open-sse/mcp-server/` alongside existing tools. Scoped under
813811
the `gamification` permission scope.
814812

815-
| Tool | Description | Input Schema |
813+
| Tool | Description | Input Schema | |
816814
| -------------------------- | ------------------------------------- | ---------------------------- | --------- |
817815
| `gamification_leaderboard` | Get leaderboard for a scope/period | `{ scope, period?, limit? }` |
818816
| `gamification_rank` | Get caller's rank and neighbors | `{ scope }` |

0 commit comments

Comments
 (0)