@mikoto_zero/minigame-open-mcp 1.1.1 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/config/toolDefinitions.d.ts.map +1 -1
- package/dist/config/toolDefinitions.js +9 -12
- package/dist/config/toolDefinitions.js.map +1 -1
- package/dist/data/leaderboardDocs.d.ts +1 -1
- package/dist/data/leaderboardDocs.d.ts.map +1 -1
- package/dist/data/leaderboardDocs.js +47 -22
- package/dist/data/leaderboardDocs.js.map +1 -1
- package/dist/server.js +1 -1
- package/package.json +2 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"toolDefinitions.d.ts","sourceRoot":"","sources":["../../src/config/toolDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAE1D;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,EAAE,
|
|
1
|
+
{"version":3,"file":"toolDefinitions.d.ts","sourceRoot":"","sources":["../../src/config/toolDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,oCAAoC,CAAC;AAE1D;;GAEG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,EAAE,CAmV3C"}
|
|
@@ -10,9 +10,7 @@ export function getToolDefinitions() {
|
|
|
10
10
|
// 🎯 Workflow Guidance Tool
|
|
11
11
|
{
|
|
12
12
|
name: 'start_leaderboard_integration',
|
|
13
|
-
description:
|
|
14
|
-
|
|
15
|
-
START HERE when user asks about integrating leaderboards, implementing rankings, or "接入排行榜".
|
|
13
|
+
description: `START HERE when user asks about integrating leaderboards, implementing rankings, or "接入排行榜".
|
|
16
14
|
|
|
17
15
|
This tool guides the complete leaderboard integration workflow:
|
|
18
16
|
1. Check if leaderboards already exist on server
|
|
@@ -37,10 +35,9 @@ Use this as the first step for any leaderboard integration request.`,
|
|
|
37
35
|
}
|
|
38
36
|
},
|
|
39
37
|
// 📖 Core LeaderboardManager API Documentation Tools (one tool per API)
|
|
40
|
-
// ⚠️ DEPRECATED: Please use Resources instead for better performance
|
|
41
38
|
{
|
|
42
39
|
name: 'get_leaderboard_manager',
|
|
43
|
-
description: '
|
|
40
|
+
description: 'Get documentation for tap.getLeaderboardManager() - how to obtain the LeaderboardManager instance. Use this when user asks how to initialize or access the leaderboard system.',
|
|
44
41
|
inputSchema: {
|
|
45
42
|
type: 'object',
|
|
46
43
|
properties: {}
|
|
@@ -48,7 +45,7 @@ Use this as the first step for any leaderboard integration request.`,
|
|
|
48
45
|
},
|
|
49
46
|
{
|
|
50
47
|
name: 'open_leaderboard',
|
|
51
|
-
description: '
|
|
48
|
+
description: 'Get documentation for leaderboardManager.openLeaderboard() - how to display the TapTap leaderboard UI. Use this when user wants to show leaderboard interface to players.',
|
|
52
49
|
inputSchema: {
|
|
53
50
|
type: 'object',
|
|
54
51
|
properties: {}
|
|
@@ -56,7 +53,7 @@ Use this as the first step for any leaderboard integration request.`,
|
|
|
56
53
|
},
|
|
57
54
|
{
|
|
58
55
|
name: 'submit_scores',
|
|
59
|
-
description: '
|
|
56
|
+
description: 'Get documentation for leaderboardManager.submitScores() - how to submit player scores to leaderboards. Use this when user wants to upload scores or update rankings.',
|
|
60
57
|
inputSchema: {
|
|
61
58
|
type: 'object',
|
|
62
59
|
properties: {}
|
|
@@ -64,7 +61,7 @@ Use this as the first step for any leaderboard integration request.`,
|
|
|
64
61
|
},
|
|
65
62
|
{
|
|
66
63
|
name: 'load_leaderboard_scores',
|
|
67
|
-
description: '
|
|
64
|
+
description: 'Get documentation for leaderboardManager.loadLeaderboardScores() - how to retrieve paginated leaderboard data. Use this when user wants to fetch top scores or implement custom leaderboard UI.',
|
|
68
65
|
inputSchema: {
|
|
69
66
|
type: 'object',
|
|
70
67
|
properties: {}
|
|
@@ -72,7 +69,7 @@ Use this as the first step for any leaderboard integration request.`,
|
|
|
72
69
|
},
|
|
73
70
|
{
|
|
74
71
|
name: 'load_current_player_score',
|
|
75
|
-
description: '
|
|
72
|
+
description: 'Get documentation for leaderboardManager.loadCurrentPlayerLeaderboardScore() - how to get current player\'s score and rank. Use this when user wants to show player their own ranking.',
|
|
76
73
|
inputSchema: {
|
|
77
74
|
type: 'object',
|
|
78
75
|
properties: {}
|
|
@@ -80,7 +77,7 @@ Use this as the first step for any leaderboard integration request.`,
|
|
|
80
77
|
},
|
|
81
78
|
{
|
|
82
79
|
name: 'load_player_centered_scores',
|
|
83
|
-
description: '
|
|
80
|
+
description: 'Get documentation for leaderboardManager.loadPlayerCenteredScores() - how to load scores of players near current user. Use this when user wants to display surrounding competitors.',
|
|
84
81
|
inputSchema: {
|
|
85
82
|
type: 'object',
|
|
86
83
|
properties: {}
|
|
@@ -103,7 +100,7 @@ Use this as the first step for any leaderboard integration request.`,
|
|
|
103
100
|
},
|
|
104
101
|
{
|
|
105
102
|
name: 'get_leaderboard_overview',
|
|
106
|
-
description: '
|
|
103
|
+
description: 'Get comprehensive overview of all TapTap leaderboard APIs and features. Use this when user wants to understand what leaderboard functionality is available.',
|
|
107
104
|
inputSchema: {
|
|
108
105
|
type: 'object',
|
|
109
106
|
properties: {}
|
|
@@ -111,7 +108,7 @@ Use this as the first step for any leaderboard integration request.`,
|
|
|
111
108
|
},
|
|
112
109
|
{
|
|
113
110
|
name: 'get_leaderboard_patterns',
|
|
114
|
-
description: '
|
|
111
|
+
description: 'Get complete implementation examples and best practices for leaderboards. Use this when user wants to see full integration code or common usage patterns.',
|
|
115
112
|
inputSchema: {
|
|
116
113
|
type: 'object',
|
|
117
114
|
properties: {}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"toolDefinitions.js","sourceRoot":"","sources":["../../src/config/toolDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO;QACL,4BAA4B;QAC5B;YACE,IAAI,EAAE,+BAA+B;YACrC,WAAW,EAAE
|
|
1
|
+
{"version":3,"file":"toolDefinitions.js","sourceRoot":"","sources":["../../src/config/toolDefinitions.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,UAAU,kBAAkB;IAChC,OAAO;QACL,4BAA4B;QAC5B;YACE,IAAI,EAAE,+BAA+B;YACrC,WAAW,EAAE;;;;;;;;;;;;;oEAaiD;YAC9D,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,OAAO,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,qEAAqE;qBACnF;iBACF;aACF;SACF;QAED,wEAAwE;QACxE;YACE,IAAI,EAAE,yBAAyB;YAC/B,WAAW,EAAE,gLAAgL;YAC7L,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,WAAW,EAAE,2KAA2K;YACxL,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QACD;YACE,IAAI,EAAE,eAAe;YACrB,WAAW,EAAE,sKAAsK;YACnL,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QACD;YACE,IAAI,EAAE,yBAAyB;YAC/B,WAAW,EAAE,iMAAiM;YAC9M,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QACD;YACE,IAAI,EAAE,2BAA2B;YACjC,WAAW,EAAE,wLAAwL;YACrM,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QACD;YACE,IAAI,EAAE,6BAA6B;YACnC,WAAW,EAAE,qLAAqL;YAClM,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QAED,kBAAkB;QAClB;YACE,IAAI,EAAE,yBAAyB;YAC/B,WAAW,EAAE,+IAA+I;YAC5J,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,wEAAwE;qBACtF;iBACF;gBACD,QAAQ,EAAE,CAAC,OAAO,CAAC;aACpB;SACF;QACD;YACE,IAAI,EAAE,0BAA0B;YAChC,WAAW,EAAE,6JAA6J;YAC1K,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QACD;YACE,IAAI,EAAE,0BAA0B;YAChC,WAAW,EAAE,2JAA2J;YACxK,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QAED,4BAA4B;QAC5B;YACE,IAAI,EAAE,mBAAmB;YACzB,WAAW,EAAE,+IAA+I;YAC5J,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QAED,sCAAsC;QACtC;YACE,IAAI,EAAE,0BAA0B;YAChC,WAAW,EAAE,qKAAqK;YAClL,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,EAAE;aACf;SACF;QACD;YACE,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,gLAAgL;YAC7L,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,YAAY,EAAE;wBACZ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,mCAAmC;qBACjD;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,kCAAkC;qBAChD;iBACF;gBACD,QAAQ,EAAE,CAAC,cAAc,EAAE,QAAQ,CAAC;aACrC;SACF;QAED,wGAAwG;QACxG;YACE,IAAI,EAAE,oBAAoB;YAC1B,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mGAkDgF;YAC7F,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,YAAY,EAAE;wBACZ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,+EAA+E;qBAC7F;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,sFAAsF;qBACpG;oBACD,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,iFAAiF;qBAC/F;oBACD,WAAW,EAAE;wBACX,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2NAA2N;wBACxO,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;qBACnB;oBACD,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,qHAAqH;wBAClI,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;qBACb;oBACD,WAAW,EAAE;wBACX,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,yJAAyJ;wBACtK,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;qBACb;oBACD,SAAS,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,0IAA0I;wBACvJ,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;qBAChB;oBACD,aAAa,EAAE;wBACb,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,8FAA8F;qBAC5G;oBACD,WAAW,EAAE;wBACX,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,uMAAuM;qBACrN;oBACD,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,uFAAuF;qBACrG;iBACF;gBACD,QAAQ,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,CAAC;aAC7E;SACF;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,WAAW,EAAE,6OAA6O;YAC1P,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,YAAY,EAAE;wBACZ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,+DAA+D;qBAC7E;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,sEAAsE;qBACpF;oBACD,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,kDAAkD;qBAChE;oBACD,SAAS,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,yCAAyC;qBACvD;iBACF;aACF;SACF;QACD;YACE,IAAI,EAAE,qBAAqB;YAC3B,WAAW,EAAE;;;;;;;;;;;;4GAYyF;YACtG,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,YAAY,EAAE;wBACZ,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,+DAA+D;qBAC7E;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,sEAAsE;qBACpF;oBACD,EAAE,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,4DAA4D;qBAC1E;oBACD,OAAO,EAAE;wBACP,IAAI,EAAE,SAAS;wBACf,WAAW,EAAE,+HAA+H;qBAC7I;iBACF;gBACD,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC;aAC5B;SACF;QAED,kDAAkD;QAClD;YACE,IAAI,EAAE,6BAA6B;YACnC,WAAW,EAAE,iNAAiN;YAC9N,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,aAAa,EAAE;wBACb,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,qGAAqG;qBACnH;oBACD,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2DAA2D;wBACxE,OAAO,EAAE,EAAE;qBACZ;iBACF;aACF;SACF;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"leaderboardDocs.d.ts","sourceRoot":"","sources":["../../src/data/leaderboardDocs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,cAAc,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CACjD;AAED,eAAO,MAAM,yBAAyB,EAAE,
|
|
1
|
+
{"version":3,"file":"leaderboardDocs.d.ts","sourceRoot":"","sources":["../../src/data/leaderboardDocs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,cAAc,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CACjD;AAED,eAAO,MAAM,yBAAyB,EAAE,wBA6evC,CAAC;AAEF;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAqChF;AAED;;GAEG;AACH,wBAAgB,sBAAsB,IAAI,MAAM,CA6C/C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAoCxD"}
|
|
@@ -1,26 +1,42 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* TapTap
|
|
2
|
+
* TapTap Leaderboard API (Minigame & H5) Documentation
|
|
3
3
|
* Based on: https://developer.taptap.cn/minigameapidoc/dev/api/open-api/leaderboard/
|
|
4
4
|
*/
|
|
5
5
|
export const LEADERBOARD_DOCUMENTATION = {
|
|
6
|
-
title: "TapTap Minigame
|
|
7
|
-
description:
|
|
6
|
+
title: "TapTap Leaderboard API (Minigame & H5)",
|
|
7
|
+
description: `Complete leaderboard functionality for TapTap Minigame and H5 Games, including score submission, ranking queries, and leaderboard display.
|
|
8
|
+
|
|
9
|
+
⚠️ IMPORTANT:
|
|
10
|
+
- NO npm packages or SDK installation required
|
|
11
|
+
- NO imports needed
|
|
12
|
+
- The 'tap' object is a GLOBAL object provided by TapTap runtime environment
|
|
13
|
+
- All APIs are accessed via: tap.getLeaderboardManager()
|
|
14
|
+
- Works in TapTap Minigame AND H5 game environments (not in regular web browsers)
|
|
15
|
+
- All methods accept a SINGLE object parameter (not multiple parameters)`,
|
|
8
16
|
apiReference: "https://developer.taptap.cn/minigameapidoc/dev/api/open-api/leaderboard/",
|
|
9
17
|
categories: {
|
|
10
18
|
initialization: {
|
|
11
19
|
title: "Initialization",
|
|
12
|
-
description: "Get the LeaderboardManager instance",
|
|
20
|
+
description: "Get the LeaderboardManager instance from the global 'tap' object (provided by TapTap runtime)",
|
|
13
21
|
apis: [
|
|
14
22
|
{
|
|
15
23
|
name: "tap.getLeaderboardManager",
|
|
16
24
|
method: "tap.getLeaderboardManager()",
|
|
17
|
-
description: "Get the LeaderboardManager instance to access leaderboard functionality",
|
|
25
|
+
description: "Get the LeaderboardManager instance to access leaderboard functionality. ⚠️ IMPORTANT: 'tap' is a GLOBAL object provided by TapTap runtime, NO imports or installations needed.",
|
|
18
26
|
returnValue: "LeaderboardManager - The leaderboard manager instance",
|
|
19
|
-
example: `//
|
|
27
|
+
example: `// ⚠️ IMPORTANT: 'tap' is a global object, NO imports needed!
|
|
28
|
+
// This works ONLY in TapTap minigame environment
|
|
29
|
+
|
|
30
|
+
// Get LeaderboardManager instance
|
|
20
31
|
const leaderboardManager = tap.getLeaderboardManager();
|
|
21
32
|
|
|
22
33
|
// Now you can use leaderboardManager to call various methods
|
|
23
|
-
|
|
34
|
+
// All methods accept a SINGLE object parameter
|
|
35
|
+
leaderboardManager.openLeaderboard({
|
|
36
|
+
leaderboardId: "your_id",
|
|
37
|
+
collection: "public",
|
|
38
|
+
callback: { onSuccess: (res) => {}, onFailure: (code, msg) => {} }
|
|
39
|
+
});`
|
|
24
40
|
}
|
|
25
41
|
]
|
|
26
42
|
},
|
|
@@ -30,7 +46,7 @@ leaderboardManager.openLeaderboard();`
|
|
|
30
46
|
apis: [
|
|
31
47
|
{
|
|
32
48
|
name: "openLeaderboard",
|
|
33
|
-
method: "leaderboardManager.openLeaderboard(leaderboardId, collection, callback)",
|
|
49
|
+
method: "leaderboardManager.openLeaderboard({ leaderboardId, collection, callback })",
|
|
34
50
|
description: "Opens TapTap's leaderboard page, displaying total and friend leaderboards for the specified leaderboard ID",
|
|
35
51
|
parameters: {
|
|
36
52
|
"leaderboardId": "string (required) - Unique identifier for the leaderboard",
|
|
@@ -82,7 +98,7 @@ leaderboardManager.openLeaderboard({
|
|
|
82
98
|
apis: [
|
|
83
99
|
{
|
|
84
100
|
name: "submitScores",
|
|
85
|
-
method: "leaderboardManager.submitScores(scores, callback)",
|
|
101
|
+
method: "leaderboardManager.submitScores({ scores, callback })",
|
|
86
102
|
description: "Batch submit user leaderboard scores. Maximum of 5 scores can be submitted at once.",
|
|
87
103
|
parameters: {
|
|
88
104
|
"scores": "Array<ScoreEntry> (required) - Array of score entries to submit, maximum 5 entries",
|
|
@@ -146,14 +162,15 @@ leaderboardManager.submitScores({
|
|
|
146
162
|
apis: [
|
|
147
163
|
{
|
|
148
164
|
name: "loadLeaderboardScores",
|
|
149
|
-
method: "leaderboardManager.loadLeaderboardScores(leaderboardId, collection, maxSize,
|
|
165
|
+
method: "leaderboardManager.loadLeaderboardScores({ leaderboardId, collection, maxSize, nextPage, periodToken, callback })",
|
|
150
166
|
description: "Retrieve paginated leaderboard data with support for friend and public rankings",
|
|
151
167
|
parameters: {
|
|
152
168
|
"leaderboardId": "string (required) - Unique identifier for the leaderboard",
|
|
153
169
|
"collection": "string (optional) - Leaderboard type: 'friends' or 'public' (default)",
|
|
154
|
-
"maxSize": "number (
|
|
155
|
-
"
|
|
156
|
-
"periodToken": "string (optional) - Time period identifier for the leaderboard",
|
|
170
|
+
"maxSize": "number (required) - Limit results between 1-200 entries",
|
|
171
|
+
"nextPage": "string | undefined (optional) - Token for pagination to get next page, pass undefined for first request",
|
|
172
|
+
"periodToken": "string | undefined (optional) - Time period identifier for the leaderboard",
|
|
173
|
+
"callback": "CommonCallback (optional) - Callback object with onSuccess and onFailure",
|
|
157
174
|
"callback.onSuccess": "function (optional) - Success callback function",
|
|
158
175
|
"callback.onFailure": "function (optional) - Failure callback with (code, message) parameters"
|
|
159
176
|
},
|
|
@@ -165,13 +182,15 @@ leaderboardManager.loadLeaderboardScores({
|
|
|
165
182
|
leaderboardId: "your_leaderboardId",
|
|
166
183
|
collection: "friends",
|
|
167
184
|
maxSize: 10,
|
|
185
|
+
nextPage: undefined, // undefined for first request
|
|
186
|
+
periodToken: undefined,
|
|
168
187
|
callback: {
|
|
169
188
|
onSuccess: function(res) {
|
|
170
189
|
console.log("Leaderboard scores:", res);
|
|
171
190
|
// res contains:
|
|
172
191
|
// - leaderboard info
|
|
173
192
|
// - scores list
|
|
174
|
-
// -
|
|
193
|
+
// - nextPage token for pagination
|
|
175
194
|
// - isTruncated flag
|
|
176
195
|
},
|
|
177
196
|
onFailure: function(code, message) {
|
|
@@ -181,21 +200,22 @@ leaderboardManager.loadLeaderboardScores({
|
|
|
181
200
|
});
|
|
182
201
|
|
|
183
202
|
// Load global leaderboard with pagination
|
|
184
|
-
let
|
|
203
|
+
let nextPageToken = undefined;
|
|
185
204
|
|
|
186
205
|
function loadNextPage() {
|
|
187
206
|
leaderboardManager.loadLeaderboardScores({
|
|
188
207
|
leaderboardId: "weekly_high_score",
|
|
189
208
|
collection: "public",
|
|
190
209
|
maxSize: 50,
|
|
191
|
-
|
|
210
|
+
nextPage: nextPageToken,
|
|
211
|
+
periodToken: undefined,
|
|
192
212
|
callback: {
|
|
193
213
|
onSuccess: function(res) {
|
|
194
214
|
console.log("Page loaded:", res.scores.length, "entries");
|
|
195
215
|
|
|
196
216
|
// Check if there are more pages
|
|
197
217
|
if (res.isTruncated) {
|
|
198
|
-
|
|
218
|
+
nextPageToken = res.nextPage;
|
|
199
219
|
// Can load next page with the new token
|
|
200
220
|
}
|
|
201
221
|
},
|
|
@@ -208,7 +228,7 @@ function loadNextPage() {
|
|
|
208
228
|
},
|
|
209
229
|
{
|
|
210
230
|
name: "loadCurrentPlayerLeaderboardScore",
|
|
211
|
-
method: "leaderboardManager.loadCurrentPlayerLeaderboardScore(leaderboardId, collection, periodToken, callback)",
|
|
231
|
+
method: "leaderboardManager.loadCurrentPlayerLeaderboardScore({ leaderboardId, collection, periodToken, callback })",
|
|
212
232
|
description: "Get the current user's score and ranking position in the specified leaderboard. Requires user to have submitted a score to this leaderboard.",
|
|
213
233
|
parameters: {
|
|
214
234
|
"leaderboardId": "string (required) - Unique identifier for the leaderboard",
|
|
@@ -224,6 +244,7 @@ const leaderboardManager = tap.getLeaderboardManager();
|
|
|
224
244
|
leaderboardManager.loadCurrentPlayerLeaderboardScore({
|
|
225
245
|
leaderboardId: "weekly_high_score",
|
|
226
246
|
collection: "public",
|
|
247
|
+
periodToken: undefined,
|
|
227
248
|
callback: {
|
|
228
249
|
onSuccess: function(res) {
|
|
229
250
|
console.log("Your score:", res.score);
|
|
@@ -240,6 +261,7 @@ leaderboardManager.loadCurrentPlayerLeaderboardScore({
|
|
|
240
261
|
leaderboardManager.loadCurrentPlayerLeaderboardScore({
|
|
241
262
|
leaderboardId: "friend_ranking",
|
|
242
263
|
collection: "friends",
|
|
264
|
+
periodToken: undefined,
|
|
243
265
|
callback: {
|
|
244
266
|
onSuccess: function(res) {
|
|
245
267
|
console.log("Your rank among friends:", res.rank);
|
|
@@ -252,13 +274,14 @@ leaderboardManager.loadCurrentPlayerLeaderboardScore({
|
|
|
252
274
|
},
|
|
253
275
|
{
|
|
254
276
|
name: "loadPlayerCenteredScores",
|
|
255
|
-
method: "leaderboardManager.loadPlayerCenteredScores(leaderboardId, collection, maxCount, periodToken, callback)",
|
|
277
|
+
method: "leaderboardManager.loadPlayerCenteredScores({ leaderboardId, collection, maxCount, periodToken, callback })",
|
|
256
278
|
description: "Retrieve scores for the current user and nearby players on a leaderboard, useful for showing surrounding competitors",
|
|
257
279
|
parameters: {
|
|
258
280
|
"leaderboardId": "string (required) - Unique identifier for the leaderboard",
|
|
259
|
-
"collection": "string (
|
|
260
|
-
"maxCount": "number (
|
|
261
|
-
"periodToken": "string (
|
|
281
|
+
"collection": "string (required) - Leaderboard type: 'friends' or 'public'",
|
|
282
|
+
"maxCount": "number (required) - Limit results between 1-25 players",
|
|
283
|
+
"periodToken": "string (required) - Time period identifier for the leaderboard",
|
|
284
|
+
"callback": "CommonCallback (required) - Callback object with onSuccess and onFailure",
|
|
262
285
|
"callback.onSuccess": "function (optional) - Success callback function",
|
|
263
286
|
"callback.onFailure": "function (optional) - Failure callback with (code, message) parameters"
|
|
264
287
|
},
|
|
@@ -270,6 +293,7 @@ leaderboardManager.loadPlayerCenteredScores({
|
|
|
270
293
|
leaderboardId: "your_leaderboardId",
|
|
271
294
|
collection: "friends",
|
|
272
295
|
maxCount: 10,
|
|
296
|
+
periodToken: "",
|
|
273
297
|
callback: {
|
|
274
298
|
onSuccess: function(res) {
|
|
275
299
|
console.log("Players around you:", res);
|
|
@@ -290,6 +314,7 @@ leaderboardManager.loadPlayerCenteredScores({
|
|
|
290
314
|
leaderboardId: "global_ranking",
|
|
291
315
|
collection: "public",
|
|
292
316
|
maxCount: 20,
|
|
317
|
+
periodToken: "",
|
|
293
318
|
callback: {
|
|
294
319
|
onSuccess: function(res) {
|
|
295
320
|
console.log("Loaded", res.scores.length, "players around you");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"leaderboardDocs.js","sourceRoot":"","sources":["../../src/data/leaderboardDocs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwBH,MAAM,CAAC,MAAM,yBAAyB,GAA6B;IACjE,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"leaderboardDocs.js","sourceRoot":"","sources":["../../src/data/leaderboardDocs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAwBH,MAAM,CAAC,MAAM,yBAAyB,GAA6B;IACjE,KAAK,EAAE,wCAAwC;IAC/C,WAAW,EAAE;;;;;;;;yEAQ0D;IACvE,YAAY,EAAE,0EAA0E;IAExF,UAAU,EAAE;QACV,cAAc,EAAE;YACd,KAAK,EAAE,gBAAgB;YACvB,WAAW,EAAE,+FAA+F;YAC5G,IAAI,EAAE;gBACJ;oBACE,IAAI,EAAE,2BAA2B;oBACjC,MAAM,EAAE,6BAA6B;oBACrC,WAAW,EAAE,iLAAiL;oBAC9L,WAAW,EAAE,uDAAuD;oBACpE,OAAO,EAAE;;;;;;;;;;;;IAYf;iBACK;aACF;SACF;QAED,OAAO,EAAE;YACP,KAAK,EAAE,qBAAqB;YAC5B,WAAW,EAAE,0CAA0C;YACvD,IAAI,EAAE;gBACJ;oBACE,IAAI,EAAE,iBAAiB;oBACvB,MAAM,EAAE,6EAA6E;oBACrF,WAAW,EAAE,4GAA4G;oBACzH,UAAU,EAAE;wBACV,eAAe,EAAE,2DAA2D;wBAC5E,YAAY,EAAE,+GAA+G;wBAC7H,oBAAoB,EAAE,iDAAiD;wBACvE,oBAAoB,EAAE,wEAAwE;qBAC/F;oBACD,WAAW,EAAE,oCAAoC;oBACjD,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAiCf;iBACK;aACF;SACF;QAED,gBAAgB,EAAE;YAChB,KAAK,EAAE,kBAAkB;YACzB,WAAW,EAAE,sCAAsC;YACnD,IAAI,EAAE;gBACJ;oBACE,IAAI,EAAE,cAAc;oBACpB,MAAM,EAAE,uDAAuD;oBAC/D,WAAW,EAAE,qFAAqF;oBAClG,UAAU,EAAE;wBACV,QAAQ,EAAE,oFAAoF;wBAC9F,wBAAwB,EAAE,2DAA2D;wBACrF,gBAAgB,EAAE,mDAAmD;wBACrE,oBAAoB,EAAE,iDAAiD;wBACvE,oBAAoB,EAAE,wEAAwE;qBAC/F;oBACD,WAAW,EAAE,mDAAmD;oBAChE,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA4Cf;iBACK;aACF;SACF;QAED,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE,uCAAuC;YACpD,IAAI,EAAE;gBACJ;oBACE,IAAI,EAAE,uBAAuB;oBAC7B,MAAM,EAAE,mHAAmH;oBAC3H,WAAW,EAAE,iFAAiF;oBAC9F,UAAU,EAAE;wBACV,eAAe,EAAE,2DAA2D;wBAC5E,YAAY,EAAE,uEAAuE;wBACrF,SAAS,EAAE,yDAAyD;wBACpE,UAAU,EAAE,yGAAyG;wBACrH,aAAa,EAAE,4EAA4E;wBAC3F,UAAU,EAAE,0EAA0E;wBACtF,oBAAoB,EAAE,iDAAiD;wBACvE,oBAAoB,EAAE,wEAAwE;qBAC/F;oBACD,WAAW,EAAE,+FAA+F;oBAC5G,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiDjB;iBACO;gBACD;oBACE,IAAI,EAAE,mCAAmC;oBACzC,MAAM,EAAE,4GAA4G;oBACpH,WAAW,EAAE,8IAA8I;oBAC3J,UAAU,EAAE;wBACV,eAAe,EAAE,2DAA2D;wBAC5E,YAAY,EAAE,uEAAuE;wBACrF,aAAa,EAAE,gEAAgE;wBAC/E,oBAAoB,EAAE,iDAAiD;wBACvE,oBAAoB,EAAE,wEAAwE;qBAC/F;oBACD,WAAW,EAAE,6DAA6D;oBAC1E,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAgCf;iBACK;gBACD;oBACE,IAAI,EAAE,0BAA0B;oBAChC,MAAM,EAAE,6GAA6G;oBACrH,WAAW,EAAE,sHAAsH;oBACnI,UAAU,EAAE;wBACV,eAAe,EAAE,2DAA2D;wBAC5E,YAAY,EAAE,6DAA6D;wBAC3E,UAAU,EAAE,wDAAwD;wBACpE,aAAa,EAAE,gEAAgE;wBAC/E,UAAU,EAAE,0EAA0E;wBACtF,oBAAoB,EAAE,iDAAiD;wBACvE,oBAAoB,EAAE,wEAAwE;qBAC/F;oBACD,WAAW,EAAE,yDAAyD;oBACtE,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAqCf;iBACK;aACF;SACF;QAED,gBAAgB,EAAE;YAChB,KAAK,EAAE,iCAAiC;YACxC,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE;gBACJ;oBACE,IAAI,EAAE,oBAAoB;oBAC1B,MAAM,EAAE,KAAK;oBACb,WAAW,EAAE,8DAA8D;oBAC3E,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8ElB;iBACQ;gBACD;oBACE,IAAI,EAAE,oBAAoB;oBAC1B,MAAM,EAAE,KAAK;oBACb,WAAW,EAAE,wDAAwD;oBACrE,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkElB;iBACQ;aACF;SACF;KACF;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAa,EAAE,QAAiB;IACpE,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IAEvC,MAAM,kBAAkB,GAAG,QAAQ;QACjC,CAAC,CAAC,CAAC,yBAAyB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClD,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;IAExD,KAAK,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;QACrC,IAAI,CAAC,GAAG;YAAE,SAAS;QAEnB,KAAK,MAAM,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAC;YACjF,IAAI,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;gBACpC,OAAO,CAAC,IAAI,CAAC;MACf,GAAG,CAAC,IAAI;;gBAEE,GAAG,CAAC,MAAM;;mBAEP,GAAG,CAAC,WAAW;;EAEhC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;EACjB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,OAAO,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;CAC1F,CAAC,CAAC,CAAC,EAAE;;EAEJ,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,EAAE;;;;EAI1D,GAAG,CAAC,OAAO;;CAEZ,CAAC,CAAC;YACG,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB;IACpC,OAAO,KAAK,yBAAyB,CAAC,KAAK;;EAE3C,yBAAyB,CAAC,WAAW;;8BAET,yBAAyB,CAAC,YAAY;;;;EAIlE,MAAM,CAAC,OAAO,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC;MACrE,GAAG,CAAC,KAAK;EACb,GAAG,CAAC,WAAW;;qBAEI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;CACrE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BZ,CAAC;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,QAAgB;IAC9C,MAAM,GAAG,GAAG,yBAAyB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3D,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAO,aAAa,QAAQ,sCAAsC,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IACnI,CAAC;IAED,OAAO,KAAK,GAAG,CAAC,KAAK;;EAErB,GAAG,CAAC,WAAW;;EAEf,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;KACjB,GAAG,CAAC,IAAI;;gBAEG,GAAG,CAAC,MAAM;;mBAEP,GAAG,CAAC,WAAW;;EAEhC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;;EAEjB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,SAAS,GAAG,SAAS,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;CAC9F,CAAC,CAAC,CAAC,EAAE;;EAEJ,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;;EAElB,GAAG,CAAC,WAAW;CAChB,CAAC,CAAC,CAAC,EAAE;;;;;EAKJ,GAAG,CAAC,OAAO;;;;CAIZ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;CACZ,CAAC;AACF,CAAC"}
|
package/dist/server.js
CHANGED
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mikoto_zero/minigame-open-mcp",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.3",
|
|
4
4
|
"type": "module",
|
|
5
|
-
"description": "TapTap
|
|
5
|
+
"description": "TapTap Open API MCP Server - Documentation and Management APIs for TapTap Minigame and H5 Games (Leaderboard, and more features coming)",
|
|
6
6
|
"main": "dist/server.js",
|
|
7
7
|
"bin": {
|
|
8
8
|
"minigame-open-mcp": "bin/minigame-open-mcp"
|