@egain/egain-mcp-server 1.0.26 → 1.0.27

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.
Files changed (96) hide show
  1. package/README.md +18 -43
  2. package/bin/mcp-server.js +335 -89
  3. package/bin/mcp-server.js.map +24 -25
  4. package/esm/src/funcs/getAnnouncements.d.ts +39 -1
  5. package/esm/src/funcs/getAnnouncements.d.ts.map +1 -1
  6. package/esm/src/funcs/getAnnouncements.js +39 -1
  7. package/esm/src/funcs/getAnnouncements.js.map +1 -1
  8. package/esm/src/funcs/getArticle.d.ts +42 -0
  9. package/esm/src/funcs/getArticle.d.ts.map +1 -1
  10. package/esm/src/funcs/getArticle.js +42 -0
  11. package/esm/src/funcs/getArticle.js.map +1 -1
  12. package/esm/src/funcs/getPopularArticles.d.ts +37 -0
  13. package/esm/src/funcs/getPopularArticles.d.ts.map +1 -1
  14. package/esm/src/funcs/getPopularArticles.js +37 -0
  15. package/esm/src/funcs/getPopularArticles.js.map +1 -1
  16. package/esm/src/funcs/getPortals.d.ts +26 -1
  17. package/esm/src/funcs/getPortals.d.ts.map +1 -1
  18. package/esm/src/funcs/getPortals.js +35 -10
  19. package/esm/src/funcs/getPortals.js.map +1 -1
  20. package/esm/src/funcs/makeSuggestion.d.ts +42 -0
  21. package/esm/src/funcs/makeSuggestion.d.ts.map +1 -1
  22. package/esm/src/funcs/makeSuggestion.js +42 -0
  23. package/esm/src/funcs/makeSuggestion.js.map +1 -1
  24. package/esm/src/funcs/queryAnswers.d.ts +41 -5
  25. package/esm/src/funcs/queryAnswers.d.ts.map +1 -1
  26. package/esm/src/funcs/queryAnswers.js +41 -5
  27. package/esm/src/funcs/queryAnswers.js.map +1 -1
  28. package/esm/src/funcs/queryRetrieve.d.ts +41 -1
  29. package/esm/src/funcs/queryRetrieve.d.ts.map +1 -1
  30. package/esm/src/funcs/queryRetrieve.js +41 -1
  31. package/esm/src/funcs/queryRetrieve.js.map +1 -1
  32. package/esm/src/funcs/querySearch.d.ts +48 -1
  33. package/esm/src/funcs/querySearch.d.ts.map +1 -1
  34. package/esm/src/funcs/querySearch.js +48 -1
  35. package/esm/src/funcs/querySearch.js.map +1 -1
  36. package/esm/src/lib/config.d.ts +2 -2
  37. package/esm/src/lib/config.js +2 -2
  38. package/esm/src/mcp-server/mcp-server.js +1 -1
  39. package/esm/src/mcp-server/server.js +1 -1
  40. package/esm/src/mcp-server/tools/getAnnouncements.d.ts.map +1 -1
  41. package/esm/src/mcp-server/tools/getAnnouncements.js +39 -1
  42. package/esm/src/mcp-server/tools/getAnnouncements.js.map +1 -1
  43. package/esm/src/mcp-server/tools/getArticle.d.ts.map +1 -1
  44. package/esm/src/mcp-server/tools/getArticle.js +42 -0
  45. package/esm/src/mcp-server/tools/getArticle.js.map +1 -1
  46. package/esm/src/mcp-server/tools/getPopularArticles.d.ts.map +1 -1
  47. package/esm/src/mcp-server/tools/getPopularArticles.js +37 -0
  48. package/esm/src/mcp-server/tools/getPopularArticles.js.map +1 -1
  49. package/esm/src/mcp-server/tools/getPortals.d.ts +1 -1
  50. package/esm/src/mcp-server/tools/getPortals.d.ts.map +1 -1
  51. package/esm/src/mcp-server/tools/getPortals.js +26 -1
  52. package/esm/src/mcp-server/tools/getPortals.js.map +1 -1
  53. package/esm/src/mcp-server/tools/makeSuggestion.d.ts.map +1 -1
  54. package/esm/src/mcp-server/tools/makeSuggestion.js +42 -0
  55. package/esm/src/mcp-server/tools/makeSuggestion.js.map +1 -1
  56. package/esm/src/mcp-server/tools/queryAnswers.d.ts.map +1 -1
  57. package/esm/src/mcp-server/tools/queryAnswers.js +41 -5
  58. package/esm/src/mcp-server/tools/queryAnswers.js.map +1 -1
  59. package/esm/src/mcp-server/tools/queryRetrieve.d.ts.map +1 -1
  60. package/esm/src/mcp-server/tools/queryRetrieve.js +41 -1
  61. package/esm/src/mcp-server/tools/queryRetrieve.js.map +1 -1
  62. package/esm/src/mcp-server/tools/querySearch.d.ts.map +1 -1
  63. package/esm/src/mcp-server/tools/querySearch.js +48 -1
  64. package/esm/src/mcp-server/tools/querySearch.js.map +1 -1
  65. package/esm/src/models/articletype.d.ts +1 -6
  66. package/esm/src/models/articletype.d.ts.map +1 -1
  67. package/esm/src/models/articletype.js +1 -15
  68. package/esm/src/models/articletype.js.map +1 -1
  69. package/esm/src/models/getmyportalsop.d.ts +2 -2
  70. package/esm/src/models/getmyportalsop.d.ts.map +1 -1
  71. package/esm/src/models/getmyportalsop.js +2 -2
  72. package/esm/src/models/getmyportalsop.js.map +1 -1
  73. package/manifest.json +10 -10
  74. package/package.json +1 -1
  75. package/src/funcs/getAnnouncements.ts +39 -1
  76. package/src/funcs/getArticle.ts +42 -0
  77. package/src/funcs/getPopularArticles.ts +37 -0
  78. package/src/funcs/getPortals.ts +37 -12
  79. package/src/funcs/makeSuggestion.ts +42 -0
  80. package/src/funcs/queryAnswers.ts +41 -5
  81. package/src/funcs/queryRetrieve.ts +41 -1
  82. package/src/funcs/querySearch.ts +48 -1
  83. package/src/lib/config.ts +2 -2
  84. package/src/mcp-server/mcp-server.ts +1 -1
  85. package/src/mcp-server/server.ts +1 -1
  86. package/src/mcp-server/tools/getAnnouncements.ts +39 -1
  87. package/src/mcp-server/tools/getArticle.ts +42 -0
  88. package/src/mcp-server/tools/getPopularArticles.ts +37 -0
  89. package/src/mcp-server/tools/getPortals.ts +26 -1
  90. package/src/mcp-server/tools/makeSuggestion.ts +42 -0
  91. package/src/mcp-server/tools/queryAnswers.ts +41 -5
  92. package/src/mcp-server/tools/queryRetrieve.ts +41 -1
  93. package/src/mcp-server/tools/querySearch.ts +48 -1
  94. package/src/models/articletype.ts +2 -19
  95. package/src/models/getmyportalsop.ts +5 -5
  96. package/src/models/mandatorylanguagequeryparameter.ts +0 -59
@@ -13,6 +13,43 @@ export const tool$getPopularArticles = {
13
13
 
14
14
  Get Popular Articles
15
15
 
16
+ ## How to Use This Tool
17
+
18
+ **CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
19
+
20
+ **Parameter Format**:
21
+ - Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999"}}\`
22
+ - Required parameter: \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
23
+ - Optional parameters:
24
+ - \`Dollar_lang\` (string, default: "en-US") - Language code
25
+ - \`Dollar_pagenum\` (number, default: 1) - Page number for pagination
26
+ - \`Dollar_pagesize\` (number, default: 10) - Number of results per page
27
+ - \`dollarFilterTopicId\` (string) - Filter by topic ID
28
+ - \`dollarFilterTags\` (string) - Comma-separated list of Tag/Tag Group IDs
29
+
30
+ **Example**: To get popular articles from portal "PZ-9999", call with:
31
+ \`\`\`json
32
+ {"request": {"portalID": "PZ-9999"}}
33
+ \`\`\`
34
+
35
+ **Example with optional parameters**:
36
+ \`\`\`json
37
+ {"request": {"portalID": "PZ-9999", "Dollar_lang": "en-US", "Dollar_pagesize": 20}}
38
+ \`\`\`
39
+
40
+ ## Displaying Results (MCP-Specific)
41
+ **CRITICAL**: When this tool returns data successfully, you MUST display the popular articles to the user in your response. Do not silently process the data - always show the user what was returned.
42
+
43
+ **What to display:**
44
+ - Display all popular articles with their names and IDs
45
+ - Show article summaries or descriptions when available
46
+ - Display metadata such as \`articleType\`, \`createdDate\`, \`modifiedDate\`
47
+ - Show \`imageURL\` if available (mention thumbnail availability)
48
+ - Include \`paginationInfo\` if pagination is used
49
+ - Format articles in a numbered or bulleted list
50
+
51
+ **Example**: "Here are the most popular articles: 1) [Article Name] (ID: PROD-123) - [summary]..."
52
+
16
53
  ## Prerequisites
17
54
  - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
18
55
  - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
@@ -1 +1 @@
1
- {"version":3,"file":"getPopularArticles.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/getPopularArticles.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,mCAAmC,EAAE,MAAM,sCAAsC,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,mCAAmC;CAC7C,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAgC;IAClE,IAAI,EAAE,sBAAsB;IAC5B,WAAW,EAAE;;;;;;;;;;;;CAYd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;KACrB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,kBAAkB,CAChD,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"getPopularArticles.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/getPopularArticles.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,mCAAmC,EAAE,MAAM,sCAAsC,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,mCAAmC;CAC7C,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAgC;IAClE,IAAI,EAAE,sBAAsB;IAC5B,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiDd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;KACrB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,kBAAkB,CAChD,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
@@ -1,6 +1,6 @@
1
1
  import { ToolDefinition } from "../tools.js";
2
2
  declare const args: {
3
- request: import("zod").ZodType<import("../../models/getmyportalsop.js").GetMyPortalsRequest, import("zod").ZodTypeDef, unknown>;
3
+ request: import("zod").ZodOptional<import("zod").ZodType<import("../../models/getmyportalsop.js").GetMyPortalsRequest, import("zod").ZodTypeDef, unknown>>;
4
4
  };
5
5
  export declare const tool$getPortals: ToolDefinition<typeof args>;
6
6
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"getPortals.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/getPortals.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,OAAO,IAAI,CA+EvD,CAAC"}
1
+ {"version":3,"file":"getPortals.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/getPortals.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,OAAO,IAAI,CAwGvD,CAAC"}
@@ -5,7 +5,7 @@ import { getPortals } from "../../funcs/getPortals.js";
5
5
  import { GetMyPortalsRequest$zodSchema } from "../../models/getmyportalsop.js";
6
6
  import { formatResult } from "../tools.js";
7
7
  const args = {
8
- request: GetMyPortalsRequest$zodSchema,
8
+ request: GetMyPortalsRequest$zodSchema.optional(),
9
9
  };
10
10
  export const tool$getPortals = {
11
11
  name: "get-portals",
@@ -13,6 +13,15 @@ export const tool$getPortals = {
13
13
 
14
14
  Get All Portals Accessible to User
15
15
 
16
+ ## How to Use This Tool
17
+
18
+ **Parameter Format**: This tool requires a \`request\` parameter containing the request object.
19
+ - **CRITICAL**: All parameters in this tool are optional. You may pass an empty request object: \`{"request": {}}\`
20
+ - If you want to specify a language, pass: \`{"request": {"Dollar_lang": "en-US"}}\`
21
+ - The \`Dollar_lang\` parameter is **optional** - if omitted, the API defaults to "en-US"
22
+ - **Example with empty request** (recommended if you don't need to specify language): \`{"request": {}}\`
23
+ - **Example with language**: \`{"request": {"Dollar_lang": "en-US"}}\`
24
+
16
25
  ## Overview
17
26
  The Get All Portals Accessible to User API allows a user to fetch all portals accessible to the user across all departments.
18
27
  - If no access tags are specified for a portal, any user can access the portal.
@@ -60,6 +69,22 @@ If you search for "business portal" and the first page returns 25 portals but no
60
69
  - Search the complete merged list before concluding the portal doesn't exist
61
70
 
62
71
  This ensures reliable portal name-to-ID resolution and prevents false "not found" errors.
72
+
73
+ ## Displaying Results (MCP-Specific)
74
+ **CRITICAL**: When this tool returns data successfully, you MUST display the portal information to the user in your response. Do not silently process the data - always show the user what was returned.
75
+
76
+ **What to display:**
77
+ - Display all portals with their names and IDs
78
+ - Show portal \`id\` (the portal ID needed for other API calls)
79
+ - Display portal \`name\` (the human-readable portal name)
80
+ - Show \`departmentName\` if available
81
+ - Include \`shortURL\` if available
82
+ - Display \`paginationInfo\` to show total count and current page
83
+ - Format portals in a clear list format (e.g., "Portal Name (ID: PORTAL-123)")
84
+
85
+ **Example**: "Here are the available portals: 1) Business Portal (ID: PORTAL-123), 2) Customer Portal (ID: PORTAL-456)..."
86
+
87
+ **Important**: Always display portal IDs clearly, as users will need these IDs to call other tools.
63
88
  `,
64
89
  annotations: {
65
90
  "destructiveHint": false,
@@ -1 +1 @@
1
- {"version":3,"file":"getPortals.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/getPortals.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,6BAA6B;CACvC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAgC;IAC1D,IAAI,EAAE,aAAa;IACnB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmDd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;KACrB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,UAAU,CACxC,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"getPortals.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/getPortals.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,6BAA6B,CAAC,QAAQ,EAAE;CAClD,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAgC;IAC1D,IAAI,EAAE,aAAa;IACnB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4Ed;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;KACrB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,UAAU,CACxC,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"makeSuggestion.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/makeSuggestion.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,cAAc,CAAC,OAAO,IAAI,CAwC3D,CAAC"}
1
+ {"version":3,"file":"makeSuggestion.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/makeSuggestion.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,cAAc,CAAC,OAAO,IAAI,CAkF3D,CAAC"}
@@ -13,6 +13,48 @@ export const tool$makeSuggestion = {
13
13
 
14
14
  Make a Suggestion
15
15
 
16
+ ## How to Use This Tool
17
+
18
+ **CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
19
+
20
+ **Parameter Format**:
21
+ - Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "CreateSuggestion": {...}}}\`
22
+ - Required parameters:
23
+ - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
24
+ - \`CreateSuggestion\` (object) - The suggestion object with:
25
+ - \`name\` (string, **required**) - Name/title of the suggestion
26
+ - \`content\` (string, **required**) - Content/description of the suggestion
27
+ - \`language\` (object, **required**) - Language object with \`code\` property (e.g., {"code": "en-US"})
28
+ - Optional parameters:
29
+ - \`acceptLanguage\` (string, default: "en-US") - Accept-Language header value
30
+ - \`CreateSuggestion\` additional optional fields:
31
+ - \`description\` (string) - Additional description
32
+ - \`feedbackArticle\` (object) - Article ID object if providing feedback on existing article: \`{"id": "PROD-2996"}\`
33
+ - \`attachments\` (object) - Attachments object
34
+ - \`customAttributes\` (array) - Custom attributes array
35
+
36
+ **Example**: To create a suggestion in portal "PZ-9999", call with:
37
+ \`\`\`json
38
+ {"request": {"portalID": "PZ-9999", "CreateSuggestion": {"name": "New Article Request", "content": "Please add information about loan rates", "language": {"code": "en-US"}}}}
39
+ \`\`\`
40
+
41
+ **Example with feedback on existing article**:
42
+ \`\`\`json
43
+ {"request": {"portalID": "PZ-9999", "CreateSuggestion": {"name": "Article Feedback", "content": "This article needs updating", "language": {"code": "en-US"}, "feedbackArticle": {"id": "PROD-2996"}}}}
44
+ \`\`\`
45
+
46
+ ## Displaying Results (MCP-Specific)
47
+ **CRITICAL**: When this tool returns data successfully, you MUST display the suggestion creation result to the user in your response. Do not silently process the data - always show the user what was returned.
48
+
49
+ **What to display:**
50
+ - Confirm that the suggestion was successfully created
51
+ - Display the suggestion \`id\` if returned in the response
52
+ - Show the suggestion \`name\` and \`content\` that was submitted
53
+ - If an error occurs, display the error message clearly
54
+ - Provide confirmation message to the user
55
+
56
+ **Example**: "Your suggestion '[Suggestion Name]' has been successfully submitted. Suggestion ID: [id]..."
57
+
16
58
  ## Prerequisites
17
59
  - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
18
60
  - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
@@ -1 +1 @@
1
- {"version":3,"file":"makeSuggestion.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/makeSuggestion.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,+BAA+B;CACzC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAgC;IAC9D,IAAI,EAAE,iBAAiB;IACvB,WAAW,EAAE;;;;;;;;;;;;CAYd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,KAAK;KACtB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,cAAc,CAC5C,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"makeSuggestion.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/makeSuggestion.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,+BAA+B;CACzC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAgC;IAC9D,IAAI,EAAE,iBAAiB;IACvB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsDd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,KAAK;KACtB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,cAAc,CAC5C,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"queryAnswers.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/queryAnswers.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,cAAc,CAAC,OAAO,IAAI,CA4CzD,CAAC"}
1
+ {"version":3,"file":"queryAnswers.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/queryAnswers.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,cAAc,CAAC,OAAO,IAAI,CAgFzD,CAAC"}
@@ -13,18 +13,54 @@ export const tool$queryAnswers = {
13
13
 
14
14
  Get Answers
15
15
 
16
+ ## How to Use This Tool
17
+
18
+ **CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
19
+
20
+ **Parameter Format**:
21
+ - Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}\`
22
+ - Required parameters:
23
+ - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
24
+ - \`q\` (string) - The search query string
25
+ - \`Dollar_lang\` (string) - Language code (e.g., "en-US")
26
+ - Optional parameters:
27
+ - \`dollarFilterUserProfileID\` (string) - User profile ID filter
28
+ - \`dollarFilterTags\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
29
+ - \`dollarFilterTopicIds\` (array) - Array of topic IDs to filter by
30
+ - \`AnswersRequest\` (object) - Request body parameters:
31
+ - \`eventId\` (string, **required**) - Event ID
32
+ - \`sessionId\` (string, **required**) - Session ID
33
+ - \`channel\` (object, **optional**, recommended to omit) - Channel information. Omit unless specifically needed. If you receive a 400 error with channel, retry without it.
34
+ - \`context\` (object) - Additional context (companyContext, pageContext, userContext)
35
+
36
+ **Example**: To get answers for query "loan information" from portal "PZ-9999", call with:
37
+ \`\`\`json
38
+ {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "AnswersRequest": {"eventId": "event-123", "sessionId": "session-456"}}}
39
+ \`\`\`
40
+
41
+ **Note**: The \`channel\` field in \`AnswersRequest\` is optional and recommended to omit unless specifically needed. The API works reliably without it.
42
+
43
+ ## Displaying Results (MCP-Specific)
44
+ **CRITICAL**: When this tool returns data successfully, you MUST display the results to the user in your response. Do not silently process the data - always show the user what was returned.
45
+
46
+ **What to display:**
47
+ - Display the \`answer.answerValue\` text prominently as the main answer to the user's query
48
+ - Indicate the answer type (\`answerType\`: "certified" or "generative")
49
+ - If \`relevanceScore\` is present, you may mention the confidence level
50
+ - List all \`references\` (article IDs and names) that were used to generate the answer
51
+ - Display \`searchResults\` showing related articles with their names, IDs, snippets, and relevance scores
52
+ - Format the answer in a clear, readable way - this is the primary response the user is seeking
53
+
54
+ **Example**: "Based on the knowledge base, here's the answer: [answerValue]. This answer was generated using information from: [list references]. Related articles: [list search results]..."
55
+
16
56
  ## Prerequisites
17
57
  - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
18
- - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
58
+ - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "PROD-1004")
19
59
 
20
60
  ## Overview
21
61
  The Answers API enables users to get the best answer for a user query. This API can return certified answers or generative answers along with search results, providing users with comprehensive responses to their questions.
22
62
 
23
63
  The API leverages AI capabilities to provide intelligent answers based on the knowledge base content, making it easier for users to find the information they need quickly and accurately.
24
-
25
- ## Request Body Notes
26
- - **channel field**: Optional. **Recommended to omit** unless specifically needed. The API works reliably without it. If you receive a 400 Bad Request error when including channel, retry the request without the channel field.
27
- - **Required fields**: eventId and sessionId are required in the request body.
28
64
  `,
29
65
  annotations: {
30
66
  "destructiveHint": false,
@@ -1 +1 @@
1
- {"version":3,"file":"queryAnswers.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/queryAnswers.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,8BAA8B;CACxC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAgC;IAC5D,IAAI,EAAE,eAAe;IACrB,WAAW,EAAE;;;;;;;;;;;;;;;;CAgBd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,KAAK;KACtB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,YAAY,CAC1C,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"queryAnswers.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/queryAnswers.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,8BAA8B,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,8BAA8B;CACxC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAgC;IAC5D,IAAI,EAAE,eAAe;IACrB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoDd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,KAAK;KACtB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,YAAY,CAC1C,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"queryRetrieve.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/queryRetrieve.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAAC,OAAO,IAAI,CA0C1D,CAAC"}
1
+ {"version":3,"file":"queryRetrieve.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/queryRetrieve.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAAC,OAAO,IAAI,CAkF1D,CAAC"}
@@ -13,9 +13,49 @@ export const tool$queryRetrieve = {
13
13
 
14
14
  Retrieve Chunks
15
15
 
16
+ ## How to Use This Tool
17
+
18
+ **CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
19
+
20
+ **Parameter Format**:
21
+ - Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}\`
22
+ - Required parameters:
23
+ - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
24
+ - \`q\` (string) - The search query string
25
+ - \`Dollar_lang\` (string) - Language code (e.g., "en-US")
26
+ - Optional parameters:
27
+ - \`dollarFilterUserProfileID\` (string) - User profile ID filter
28
+ - \`dollarFilterTags\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
29
+ - \`dollarFilterTopicIds\` (array) - Array of topic IDs to filter by
30
+ - \`RetrieveRequest\` (object) - Additional request body parameters:
31
+ - \`channel\` (object) - Channel information (optional, recommended to omit)
32
+ - \`eventId\` (string) - Event ID
33
+ - \`sessionId\` (string) - Session ID
34
+
35
+ **Example**: To retrieve chunks for query "loan information" from portal "PZ-9999", call with:
36
+ \`\`\`json
37
+ {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}
38
+ \`\`\`
39
+
40
+ **Example with RetrieveRequest body**:
41
+ \`\`\`json
42
+ {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "RetrieveRequest": {"eventId": "event-123", "sessionId": "session-456"}}}
43
+ \`\`\`
44
+
45
+ ## Displaying Results (MCP-Specific)
46
+ **CRITICAL**: When this tool returns data successfully, you MUST display the results to the user in your response. Do not silently process the data - always show the user what was returned.
47
+
48
+ **What to display:**
49
+ - If a certified answer is returned (\`answer\` object), display the \`answerValue\` text and list the \`references\` (article IDs and names)
50
+ - Display all \`searchResults\` with their article names, IDs, snippets, and relevance scores (\`normalizedScore\`)
51
+ - Show article metadata such as \`docType\`, \`source\`, and \`topicBreadcrumb\` when available
52
+ - Format the results in a user-friendly way (e.g., numbered list, formatted text)
53
+
54
+ **Example**: "I found 5 relevant articles about loan information: 1) [Article Name] (ID: PROD-123) - [snippet]..."
55
+
16
56
  ## Prerequisites
17
57
  - **Requires a valid portal ID** (required parameter). If you don't have the portal ID, first call 'get-portals' to get available portals.
18
- - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
58
+ - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "PROD-1004")
19
59
 
20
60
  ## Overview
21
61
  The Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines.
@@ -1 +1 @@
1
- {"version":3,"file":"queryRetrieve.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/queryRetrieve.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,+BAA+B;CACzC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAgC;IAC7D,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE;;;;;;;;;;;;;;CAcd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,KAAK;KACtB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,aAAa,CAC3C,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"queryRetrieve.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/queryRetrieve.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC;AACnF,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,+BAA+B;CACzC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAgC;IAC7D,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsDd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,KAAK;KACtB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,aAAa,CAC3C,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"querySearch.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/querySearch.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAAC,OAAO,IAAI,CA+BxD,CAAC"}
1
+ {"version":3,"file":"querySearch.d.ts","sourceRoot":"","sources":["../../../../src/mcp-server/tools/querySearch.ts"],"names":[],"mappings":"AAMA,OAAO,EAAgB,cAAc,EAAE,MAAM,aAAa,CAAC;AAE3D,QAAA,MAAM,IAAI;;CAET,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAAC,OAAO,IAAI,CA8ExD,CAAC"}
@@ -11,7 +11,54 @@ export const tool$querySearch = {
11
11
  name: "query-search",
12
12
  description: `Hybrid Search
13
13
 
14
- The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores. <br>**This endpoint is only available for Self Service environments.**
14
+ Hybrid Search
15
+
16
+ ## How to Use This Tool
17
+
18
+ **CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
19
+
20
+ **Parameter Format**:
21
+ - Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "q": "loan information"}}\`
22
+ - Required parameters:
23
+ - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
24
+ - \`q\` (string) - The search query string (must be URL-escaped)
25
+ - Optional parameters:
26
+ - \`Dollar_lang\` (string, default: "en-US") - Language code
27
+ - \`dollarFilterUserProfileID\` (string) - User profile ID filter
28
+ - \`dollarFilterTags\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
29
+ - \`dollarFilterTopicIds\` (array) - Array of topic IDs to filter by
30
+ - \`articleCustomAdditionalAttributes\` (string) - Comma-separated custom attribute names
31
+ - \`Dollar_pagenum\` (number, default: 1) - Page number for pagination
32
+ - \`Dollar_pagesize\` (number, default: 20) - Number of results per page
33
+
34
+ **Example**: To search for "loan information" in portal "PZ-9999", call with:
35
+ \`\`\`json
36
+ {"request": {"portalID": "PZ-9999", "q": "loan information"}}
37
+ \`\`\`
38
+
39
+ **Example with optional parameters**:
40
+ \`\`\`json
41
+ {"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "Dollar_pagesize": 25}}
42
+ \`\`\`
43
+
44
+ **Note**: This endpoint is only available for Self Service environments.
45
+
46
+ ## Displaying Results (MCP-Specific)
47
+ **CRITICAL**: When this tool returns data successfully, you MUST display the search results to the user in your response. Do not silently process the data - always show the user what was returned.
48
+
49
+ **What to display:**
50
+ - Display all search results with article names and IDs
51
+ - Show article \`snippet\` or \`keywordSnippet\` (the relevant text excerpt)
52
+ - Display \`normalizedScore\` or \`relevanceScore\` to indicate relevance
53
+ - Show \`docType\`, \`source\`, and \`topicBreadcrumb\` metadata
54
+ - Display \`contextualSummary\` if available
55
+ - Include \`paginationInfo\` if pagination is used
56
+ - Format results in a numbered list with clear relevance indicators
57
+
58
+ **Example**: "I found 10 articles matching 'loan information': 1) [Article Name] (ID: PROD-123) - [snippet] (Relevance: 0.89)..."
59
+
60
+ ## Overview
61
+ The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores.
15
62
  `,
16
63
  annotations: {
17
64
  "destructiveHint": false,
@@ -1 +1 @@
1
- {"version":3,"file":"querySearch.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/querySearch.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,yBAAyB;CACnC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAgC;IAC3D,IAAI,EAAE,cAAc;IACpB,WAAW,EAAE;;;CAGd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;KACrB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,WAAW,CACzC,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"querySearch.js","sourceRoot":"","sources":["../../../../src/mcp-server/tools/querySearch.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,YAAY,EAAkB,MAAM,aAAa,CAAC;AAE3D,MAAM,IAAI,GAAG;IACX,OAAO,EAAE,yBAAyB;CACnC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAgC;IAC3D,IAAI,EAAE,cAAc;IACpB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkDd;IACC,WAAW,EAAE;QACX,iBAAiB,EAAE,KAAK;QACxB,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;KACrB;IACD,IAAI;IACJ,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE;QAChC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,WAAW,CACzC,MAAM,EACN,IAAI,CAAC,OAAO,EACZ,EAAE,YAAY,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,CACzC,CAAC,QAAQ,EAAE,CAAC;QAEb,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;gBACvD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAE3B,OAAO,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;CACF,CAAC"}
@@ -1,15 +1,10 @@
1
1
  import * as z from "zod";
2
- /**
3
- * Indicates the article category name.
4
- */
5
- export declare const TypeName$zodSchema: z.ZodEnum<["General", "Guided Help", "Data Link", "PDF Content", "Topic Home", "Suggestion", "Virtual Assistant Action", "Rich Message", "Library Content"]>;
6
- export type TypeName = z.infer<typeof TypeName$zodSchema>;
7
2
  /**
8
3
  * The type of the Article and its attributes.
9
4
  */
10
5
  export type ArticleType = {
11
6
  articleCategoryId?: number | undefined;
12
- typeName?: TypeName | undefined;
7
+ typeName?: string | undefined;
13
8
  useStructuredAuthoring?: boolean | undefined;
14
9
  articleTypeId?: string | undefined;
15
10
  };
@@ -1 +1 @@
1
- {"version":3,"file":"articletype.d.ts","sourceRoot":"","sources":["../../../src/models/articletype.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;GAEG;AACH,eAAO,MAAM,kBAAkB,8JAUoB,CAAC;AAEpD,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAChC,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAC3C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CAMiD,CAAC"}
1
+ {"version":3,"file":"articletype.d.ts","sourceRoot":"","sources":["../../../src/models/articletype.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAC3C,WAAW,EACX,CAAC,CAAC,UAAU,EACZ,OAAO,CAMiD,CAAC"}
@@ -2,24 +2,10 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
  import * as z from "zod";
5
- /**
6
- * Indicates the article category name.
7
- */
8
- export const TypeName$zodSchema = z.enum([
9
- "General",
10
- "Guided Help",
11
- "Data Link",
12
- "PDF Content",
13
- "Topic Home",
14
- "Suggestion",
15
- "Virtual Assistant Action",
16
- "Rich Message",
17
- "Library Content",
18
- ]).describe("Indicates the article category name.");
19
5
  export const ArticleType$zodSchema = z.object({
20
6
  articleCategoryId: z.number().int().optional(),
21
7
  articleTypeId: z.string().optional(),
22
- typeName: TypeName$zodSchema.optional(),
8
+ typeName: z.string().optional(),
23
9
  useStructuredAuthoring: z.boolean().optional(),
24
10
  }).describe("The type of the Article and its attributes.");
25
11
  //# sourceMappingURL=articletype.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"articletype.js","sourceRoot":"","sources":["../../../src/models/articletype.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC;IACvC,SAAS;IACT,aAAa;IACb,WAAW;IACX,aAAa;IACb,YAAY;IACZ,YAAY;IACZ,0BAA0B;IAC1B,cAAc;IACd,iBAAiB;CAClB,CAAC,CAAC,QAAQ,CAAC,sCAAsC,CAAC,CAAC;AAcpD,MAAM,CAAC,MAAM,qBAAqB,GAI9B,CAAC,CAAC,MAAM,CAAC;IACX,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC9C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACvC,sBAAsB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC,QAAQ,CAAC,6CAA6C,CAAC,CAAC"}
1
+ {"version":3,"file":"articletype.js","sourceRoot":"","sources":["../../../src/models/articletype.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAYzB,MAAM,CAAC,MAAM,qBAAqB,GAI9B,CAAC,CAAC,MAAM,CAAC;IACX,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC9C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,sBAAsB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAC/C,CAAC,CAAC,QAAQ,CAAC,6CAA6C,CAAC,CAAC"}
@@ -1,13 +1,13 @@
1
1
  import * as z from "zod";
2
2
  import { AcceptLanguage } from "./acceptlanguage.js";
3
3
  import { AllAccessiblePortals } from "./allaccessibleportals.js";
4
- import { MandatoryLanguageQueryParameter } from "./mandatorylanguagequeryparameter.js";
4
+ import { LanguageQueryParameter } from "./languagequeryparameter.js";
5
5
  import { Order } from "./order.js";
6
6
  import { SortIdNameDepartment } from "./sortidnamedepartment.js";
7
7
  import { WSErrorCommon } from "./wserrorcommon.js";
8
8
  export type GetMyPortalsRequest = {
9
9
  acceptLanguage?: AcceptLanguage | undefined;
10
- Dollar_lang: MandatoryLanguageQueryParameter;
10
+ Dollar_lang?: LanguageQueryParameter | undefined;
11
11
  department?: string | undefined;
12
12
  filterText?: string | undefined;
13
13
  shortUrlTemplate?: string | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"getmyportalsop.d.ts","sourceRoot":"","sources":["../../../src/models/getmyportalsop.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACL,oBAAoB,EAErB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,+BAA+B,EAEhC,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAmB,MAAM,YAAY,CAAC;AACpD,OAAO,EACL,oBAAoB,EAErB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAE5E,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C,WAAW,EAAE,+BAA+B,CAAC;IAC7C,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,WAAW,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC/C,YAAY,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAqBP,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,QAAQ,CAAC;IACtB,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IACxD,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,oBAAoB,EACpB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC"}
1
+ {"version":3,"file":"getmyportalsop.d.ts","sourceRoot":"","sources":["../../../src/models/getmyportalsop.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,cAAc,EAA4B,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EACL,oBAAoB,EAErB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,KAAK,EAAmB,MAAM,YAAY,CAAC;AACpD,OAAO,EACL,oBAAoB,EAErB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,aAAa,EAA2B,MAAM,oBAAoB,CAAC;AAE5E,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAC5C,WAAW,CAAC,EAAE,sBAAsB,GAAG,SAAS,CAAC;IACjD,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,WAAW,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IAC/C,YAAY,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,OAAO,CACnD,mBAAmB,EACnB,CAAC,CAAC,UAAU,EACZ,OAAO,CAqBP,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,QAAQ,CAAC;IACtB,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IACxD,aAAa,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;CAC3C,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,oBAAoB,EACpB,CAAC,CAAC,UAAU,EACZ,OAAO,CAOP,CAAC"}
@@ -4,12 +4,12 @@
4
4
  import * as z from "zod";
5
5
  import { AcceptLanguage$zodSchema } from "./acceptlanguage.js";
6
6
  import { AllAccessiblePortals$zodSchema, } from "./allaccessibleportals.js";
7
- import { MandatoryLanguageQueryParameter$zodSchema, } from "./mandatorylanguagequeryparameter.js";
7
+ import { LanguageQueryParameter$zodSchema, } from "./languagequeryparameter.js";
8
8
  import { Order$zodSchema } from "./order.js";
9
9
  import { SortIdNameDepartment$zodSchema, } from "./sortidnamedepartment.js";
10
10
  import { WSErrorCommon$zodSchema } from "./wserrorcommon.js";
11
11
  export const GetMyPortalsRequest$zodSchema = z.object({
12
- Dollar_lang: MandatoryLanguageQueryParameter$zodSchema,
12
+ Dollar_lang: LanguageQueryParameter$zodSchema.default("en-US"),
13
13
  Dollar_order: Order$zodSchema.optional(),
14
14
  Dollar_pagenum: z.number().int().default(1).describe("Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."),
15
15
  Dollar_pagesize: z.number().int().default(25).describe("Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.<br>Valid range of 5-75<br>_Default value_: 25"),
@@ -1 +1 @@
1
- {"version":3,"file":"getmyportalsop.js","sourceRoot":"","sources":["../../../src/models/getmyportalsop.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAkB,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAEL,8BAA8B,GAC/B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAEL,yCAAyC,GAC1C,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAS,eAAe,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAEL,8BAA8B,GAC/B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAiB,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAc5E,MAAM,CAAC,MAAM,6BAA6B,GAItC,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,yCAAyC;IACtD,YAAY,EAAE,eAAe,CAAC,QAAQ,EAAE;IACxC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAClD,oHAAoH,CACrH;IACD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CACpD,sJAAsJ,CACvJ;IACD,WAAW,EAAE,8BAA8B,CAAC,QAAQ,EAAE;IACtD,cAAc,EAAE,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC;IACzD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAC7B,gEAAgE,CACjE,CAAC,QAAQ,EAAE;IACZ,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAC7B,qFAAqF,CACtF,CAAC,QAAQ,EAAE;IACZ,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACnC,yDAAyD,CAC1D,CAAC,QAAQ,EAAE;CACb,CAAC,CAAC;AAUH,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,oBAAoB,EAAE,8BAA8B,CAAC,QAAQ,EAAE;IAC/D,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,aAAa,EAAE,uBAAuB,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC"}
1
+ {"version":3,"file":"getmyportalsop.js","sourceRoot":"","sources":["../../../src/models/getmyportalsop.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAkB,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAEL,8BAA8B,GAC/B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAEL,gCAAgC,GACjC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAS,eAAe,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAEL,8BAA8B,GAC/B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAiB,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAc5E,MAAM,CAAC,MAAM,6BAA6B,GAItC,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,gCAAgC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9D,YAAY,EAAE,eAAe,CAAC,QAAQ,EAAE;IACxC,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAClD,oHAAoH,CACrH;IACD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,QAAQ,CACpD,sJAAsJ,CACvJ;IACD,WAAW,EAAE,8BAA8B,CAAC,QAAQ,EAAE;IACtD,cAAc,EAAE,wBAAwB,CAAC,OAAO,CAAC,OAAO,CAAC;IACzD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAC7B,gEAAgE,CACjE,CAAC,QAAQ,EAAE;IACZ,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAC7B,qFAAqF,CACtF,CAAC,QAAQ,EAAE;IACZ,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CACnC,yDAAyD,CAC1D,CAAC,QAAQ,EAAE;CACb,CAAC,CAAC;AAUH,MAAM,CAAC,MAAM,8BAA8B,GAIvC,CAAC,CAAC,MAAM,CAAC;IACX,oBAAoB,EAAE,8BAA8B,CAAC,QAAQ,EAAE;IAC/D,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC;IACnC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,aAAa,EAAE,uBAAuB,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC"}