@egain/egain-mcp-server 1.0.21 → 1.0.23

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 (172) hide show
  1. package/README.md +3 -3
  2. package/bin/mcp-server.js +294 -114
  3. package/bin/mcp-server.js.map +40 -34
  4. package/esm/src/funcs/queryAnswers.d.ts +7 -3
  5. package/esm/src/funcs/queryAnswers.d.ts.map +1 -1
  6. package/esm/src/funcs/queryAnswers.js +9 -7
  7. package/esm/src/funcs/queryAnswers.js.map +1 -1
  8. package/esm/src/funcs/queryRetrieve.d.ts +2 -2
  9. package/esm/src/funcs/queryRetrieve.d.ts.map +1 -1
  10. package/esm/src/funcs/queryRetrieve.js +4 -10
  11. package/esm/src/funcs/queryRetrieve.js.map +1 -1
  12. package/esm/src/funcs/querySearch.d.ts +3 -3
  13. package/esm/src/funcs/querySearch.d.ts.map +1 -1
  14. package/esm/src/funcs/querySearch.js +9 -3
  15. package/esm/src/funcs/querySearch.js.map +1 -1
  16. package/esm/src/hooks/server-routing-hook.js +2 -2
  17. package/esm/src/hooks/server-routing-hook.js.map +1 -1
  18. package/esm/src/lib/config.d.ts +2 -2
  19. package/esm/src/lib/config.js +2 -2
  20. package/esm/src/mcp-server/mcp-server.js +1 -1
  21. package/esm/src/mcp-server/server.js +4 -4
  22. package/esm/src/mcp-server/server.js.map +1 -1
  23. package/esm/src/mcp-server/tools/queryAnswers.d.ts +1 -1
  24. package/esm/src/mcp-server/tools/queryAnswers.d.ts.map +1 -1
  25. package/esm/src/mcp-server/tools/queryAnswers.js +7 -3
  26. package/esm/src/mcp-server/tools/queryAnswers.js.map +1 -1
  27. package/esm/src/mcp-server/tools/queryRetrieve.d.ts +1 -1
  28. package/esm/src/mcp-server/tools/queryRetrieve.js +2 -2
  29. package/esm/src/mcp-server/tools/queryRetrieve.js.map +1 -1
  30. package/esm/src/mcp-server/tools/querySearch.js +1 -1
  31. package/esm/src/models/additionalsnippets.d.ts +2 -1
  32. package/esm/src/models/additionalsnippets.d.ts.map +1 -1
  33. package/esm/src/models/additionalsnippets.js +2 -1
  34. package/esm/src/models/additionalsnippets.js.map +1 -1
  35. package/esm/src/models/aisearchop.d.ts +8 -4
  36. package/esm/src/models/aisearchop.d.ts.map +1 -1
  37. package/esm/src/models/aisearchop.js +16 -6
  38. package/esm/src/models/aisearchop.js.map +1 -1
  39. package/esm/src/models/aisearchresponse.d.ts +16 -0
  40. package/esm/src/models/aisearchresponse.d.ts.map +1 -0
  41. package/esm/src/models/aisearchresponse.js +14 -0
  42. package/esm/src/models/aisearchresponse.js.map +1 -0
  43. package/esm/src/models/aispaginationinfo.d.ts +10 -0
  44. package/esm/src/models/aispaginationinfo.d.ts.map +1 -0
  45. package/esm/src/models/aispaginationinfo.js +12 -0
  46. package/esm/src/models/aispaginationinfo.js.map +1 -0
  47. package/esm/src/models/aitopicbreadcrumb.d.ts +10 -0
  48. package/esm/src/models/aitopicbreadcrumb.d.ts.map +1 -0
  49. package/esm/src/models/aitopicbreadcrumb.js +9 -0
  50. package/esm/src/models/aitopicbreadcrumb.js.map +1 -0
  51. package/esm/src/models/aitopicsummary.d.ts +10 -0
  52. package/esm/src/models/aitopicsummary.d.ts.map +1 -0
  53. package/esm/src/models/aitopicsummary.js +9 -0
  54. package/esm/src/models/aitopicsummary.js.map +1 -0
  55. package/esm/src/models/answersrequest.d.ts +22 -11
  56. package/esm/src/models/answersrequest.d.ts.map +1 -1
  57. package/esm/src/models/answersrequest.js +22 -10
  58. package/esm/src/models/answersrequest.js.map +1 -1
  59. package/esm/src/models/answersresponse.d.ts +3 -2
  60. package/esm/src/models/answersresponse.d.ts.map +1 -1
  61. package/esm/src/models/answersresponse.js +2 -1
  62. package/esm/src/models/answersresponse.js.map +1 -1
  63. package/esm/src/models/article.d.ts +1 -1
  64. package/esm/src/models/article.d.ts.map +1 -1
  65. package/esm/src/models/articleaisearchresult.d.ts +58 -0
  66. package/esm/src/models/articleaisearchresult.d.ts.map +1 -0
  67. package/esm/src/models/articleaisearchresult.js +63 -0
  68. package/esm/src/models/articleaisearchresult.js.map +1 -0
  69. package/esm/src/models/articletype.d.ts +1 -1
  70. package/esm/src/models/articletype.d.ts.map +1 -1
  71. package/esm/src/models/articletype.js +1 -0
  72. package/esm/src/models/articletype.js.map +1 -1
  73. package/esm/src/models/createsuggestion.d.ts +1 -1
  74. package/esm/src/models/createsuggestion.d.ts.map +1 -1
  75. package/esm/src/models/createsuggestion.js +13 -1
  76. package/esm/src/models/createsuggestion.js.map +1 -1
  77. package/esm/src/models/getbestanswerop.d.ts +24 -0
  78. package/esm/src/models/getbestanswerop.d.ts.map +1 -0
  79. package/esm/src/models/getbestanswerop.js +30 -0
  80. package/esm/src/models/getbestanswerop.js.map +1 -0
  81. package/esm/src/models/languagecodeparameter.d.ts +1 -1
  82. package/esm/src/models/languagecodeparameter.d.ts.map +1 -1
  83. package/esm/src/models/languagecodeparameter.js +11 -0
  84. package/esm/src/models/languagecodeparameter.js.map +1 -1
  85. package/esm/src/models/languagequeryparameter.d.ts +1 -1
  86. package/esm/src/models/languagequeryparameter.d.ts.map +1 -1
  87. package/esm/src/models/languagequeryparameter.js +11 -0
  88. package/esm/src/models/languagequeryparameter.js.map +1 -1
  89. package/esm/src/models/mandatorylanguagequeryparameter.d.ts +1 -1
  90. package/esm/src/models/mandatorylanguagequeryparameter.d.ts.map +1 -1
  91. package/esm/src/models/mandatorylanguagequeryparameter.js +12 -0
  92. package/esm/src/models/mandatorylanguagequeryparameter.js.map +1 -1
  93. package/esm/src/models/referenceresponse.d.ts +2 -2
  94. package/esm/src/models/referenceresponse.d.ts.map +1 -1
  95. package/esm/src/models/referenceresponse.js +2 -2
  96. package/esm/src/models/referenceresponse.js.map +1 -1
  97. package/esm/src/models/requiredlanguagecode.d.ts +7 -0
  98. package/esm/src/models/requiredlanguagecode.d.ts.map +1 -0
  99. package/esm/src/models/requiredlanguagecode.js +41 -0
  100. package/esm/src/models/requiredlanguagecode.js.map +1 -0
  101. package/esm/src/models/retrievechunksop.d.ts +24 -0
  102. package/esm/src/models/retrievechunksop.d.ts.map +1 -0
  103. package/esm/src/models/retrievechunksop.js +30 -0
  104. package/esm/src/models/retrievechunksop.js.map +1 -0
  105. package/esm/src/models/retrieverequest.d.ts +1 -0
  106. package/esm/src/models/retrieverequest.d.ts.map +1 -1
  107. package/esm/src/models/retrieverequest.js +1 -0
  108. package/esm/src/models/retrieverequest.js.map +1 -1
  109. package/esm/src/models/retrieveresponse.d.ts +2 -1
  110. package/esm/src/models/retrieveresponse.d.ts.map +1 -1
  111. package/esm/src/models/retrieveresponse.js +2 -1
  112. package/esm/src/models/retrieveresponse.js.map +1 -1
  113. package/esm/src/models/schemastags.d.ts +7 -0
  114. package/esm/src/models/schemastags.d.ts.map +1 -0
  115. package/esm/src/models/schemastags.js +9 -0
  116. package/esm/src/models/schemastags.js.map +1 -0
  117. package/esm/src/models/searchresult.d.ts +6 -4
  118. package/esm/src/models/searchresult.d.ts.map +1 -1
  119. package/esm/src/models/searchresult.js +7 -5
  120. package/esm/src/models/searchresult.js.map +1 -1
  121. package/esm/src/models/tags.d.ts +2 -2
  122. package/esm/src/models/tags.d.ts.map +1 -1
  123. package/esm/src/models/tags.js +2 -2
  124. package/esm/src/models/tags.js.map +1 -1
  125. package/esm/src/models/topicsummary.d.ts +2 -0
  126. package/esm/src/models/topicsummary.d.ts.map +1 -1
  127. package/esm/src/models/topicsummary.js +2 -0
  128. package/esm/src/models/topicsummary.js.map +1 -1
  129. package/esm/src/models/wserrorcommon.d.ts +1 -1
  130. package/esm/src/models/wserrorcommon.d.ts.map +1 -1
  131. package/esm/src/models/wserrorcommon.js +1 -1
  132. package/esm/src/models/wserrorcommon.js.map +1 -1
  133. package/manifest.json +12 -12
  134. package/package.json +1 -1
  135. package/src/funcs/queryAnswers.ts +20 -18
  136. package/src/funcs/queryRetrieve.ts +15 -21
  137. package/src/funcs/querySearch.ts +16 -9
  138. package/src/hooks/server-routing-hook.ts +2 -2
  139. package/src/lib/config.ts +2 -2
  140. package/src/mcp-server/mcp-server.ts +1 -1
  141. package/src/mcp-server/server.ts +4 -4
  142. package/src/mcp-server/tools/queryAnswers.ts +7 -3
  143. package/src/mcp-server/tools/queryRetrieve.ts +2 -2
  144. package/src/mcp-server/tools/querySearch.ts +1 -1
  145. package/src/models/additionalsnippets.ts +4 -2
  146. package/src/models/aisearchop.ts +33 -9
  147. package/src/models/aisearchresponse.ts +42 -0
  148. package/src/models/aispaginationinfo.ts +24 -0
  149. package/src/models/aitopicbreadcrumb.ts +21 -0
  150. package/src/models/aitopicsummary.ts +24 -0
  151. package/src/models/answersrequest.ts +42 -23
  152. package/src/models/answersresponse.ts +5 -3
  153. package/src/models/article.ts +1 -1
  154. package/src/models/{articlesearchresult.ts → articleaisearchresult.ts} +39 -37
  155. package/src/models/articletype.ts +1 -0
  156. package/src/models/createsuggestion.ts +13 -1
  157. package/src/models/{postportalidanswersop.ts → getbestanswerop.ts} +19 -12
  158. package/src/models/languagecodeparameter.ts +11 -0
  159. package/src/models/languagequeryparameter.ts +11 -0
  160. package/src/models/mandatorylanguagequeryparameter.ts +12 -0
  161. package/src/models/referenceresponse.ts +5 -5
  162. package/src/models/requiredlanguagecode.ts +48 -0
  163. package/src/models/{postportalidretrieveop.ts → retrievechunksop.ts} +19 -15
  164. package/src/models/retrieverequest.ts +2 -0
  165. package/src/models/retrieveresponse.ts +4 -2
  166. package/src/models/schemastags.ts +19 -0
  167. package/src/models/searchresult.ts +13 -9
  168. package/src/models/tag.ts +12 -0
  169. package/src/models/tags.ts +3 -6
  170. package/src/models/topicsummary.ts +3 -0
  171. package/src/models/wserrorcommon.ts +2 -2
  172. package/src/models/searchresponse.ts +0 -34
package/README.md CHANGED
@@ -32,7 +32,7 @@ Learn more about the tools and usage of the MCP in the [eGain MCP guide](https:/
32
32
  - AI Services enabled for the tenant and target portal
33
33
  - Knowledge portal and article content available
34
34
  - Supported browser: Chrome, Edge, or Brave
35
- - A PKCE-friendly client application in your eGain tenant
35
+ - A client application configured in your eGain tenant
36
36
 
37
37
  > ℹ️ MCP access always mirrors the authenticated user’s permissions (portal and article visibility).
38
38
 
@@ -77,14 +77,14 @@ If you're having trouble configuring your MCP client, see these detailed guides:
77
77
  Once you've set up the server on your client, **run your first eGain MCP query** and a browser window will popup for authentication.
78
78
 
79
79
  **Requirements for authentication:**
80
- - A PKCE-friendly client application (SPA platform type recommended)
80
+ - A client application configured in your eGain tenant (some environments may have a pre-configured **APIs Trial** client app)
81
81
  - A supported browser (Chrome, Edge, or Brave — Safari is not supported)
82
82
  - Delegated API permissions in your client app:
83
83
  - `knowledge.portalmgr.manage`
84
84
  - `knowledge.portalmgr.read`
85
85
  - `core.aiservices.read`
86
86
 
87
- You'll need to enter your authentication configuration values in the browser form. For a tutorial, see the [Authentication Deep Dive](./help/authentication.md). Please contact your eGain PA if you do not have access to client application settings.
87
+ You'll need to enter your authentication configuration values in the browser form. For a tutorial, see the [Authentication Deep Dive](./help/authentication.md). If you need to create a client application, see the [API Authentication Guide](https://apidev.egain.com/developer-portal/get-started/authentication_guide/) — **be sure to select SPA (Single Page Application) as the platform type**. Please contact your eGain PA if you do not have access to client application settings.
88
88
 
89
89
  <!-- No Installation [installation] -->
90
90