@egain/egain-mcp-server 1.0.26 → 1.0.27

package/README.md

@@ -31,18 +31,19 @@ Learn more about the tools and usage of the MCP in the [eGain MCP guide](https:/
 - eGain platform version **21.22 or newer**
 - AI Services enabled for the tenant and target portal
 - Knowledge portal and article content available
-- Supported browser: Chrome, Edge, or Brave
-- A client application configured in your eGain tenant
+- **Supported browser:** Chrome, Edge, or Brave
+- **Client application** configured in your eGain tenant (some environments have a pre-configured **APIs Trial** app)
+- Delegated API permissions in your client app: `knowledge.portalmgr.manage`, `knowledge.portalmgr.read`, `core.aiservices.read`
 
-> ℹ️ MCP access always mirrors the authenticated user’s permissions (portal and article visibility).
+> ℹ️ MCP access always mirrors the authenticated user's permissions (portal and article visibility).
 
 ## Installation
 
 https://github.com/user-attachments/assets/2cecc8ff-6a90-4c26-92e1-6720f9124297
 
-### Step 1: Configure your MCP client (Cursor, Claude Desktop, Windsurf, VS Code, etc.) with the following:
+### Configure your MCP client
 
-**Note:** Replace `"..."` with your API domain (instructions in **Step 2**).
+Add this to your MCP client settings (Cursor, Claude Desktop, etc.), replacing `...` with your eGain API domain:
 
 ```json
 {
@@ -60,54 +61,28 @@ https://github.com/user-attachments/assets/2cecc8ff-6a90-4c26-92e1-6720f9124297
 }
 ```
 
-### Step 2: Find your API domain using the eGain Administrator Console
-1. Sign in as a Partition Admin → go to `Partition` → `Integration` → `Client Application`.
-2. Click `Metadata`. The value `API Domain` is detailed in the window.  
+<details>
+<summary><strong>How do I find my API domain?</strong></summary>
 
-Please contact your eGain PA if you do not have access to these admin-only details.
+1. Sign in to the eGain Administrator Console as a Partition Admin
+2. Go to `Partition` → `Integration` → `Client Application` → `Metadata`
+3. Copy the `API Domain` value
 
-That's it! The MCP server will be automatically downloaded and run when needed.
+Contact your eGain PA if you do not have access to these admin-only details.
+</details>
 
-If you're having trouble configuring your MCP client, see these detailed guides:
-- Claude quick-start and example queries: [Claude Guide](./help/claude-example.md)
-- Cursor quick-start and example queries: [Cursor Guide](./help/cursor-example.md)
+The MCP server will be automatically downloaded and run when needed. For client-specific setup, see the [Claude Guide](./help/claude-example.md) or [Cursor Guide](./help/cursor-example.md).
 
-### Step 3: Make a query and authenticate
+### Authenticate
 
-Once you've set up the server on your client, **run your first eGain MCP query** and a browser window will popup for authentication.
+https://github.com/user-attachments/assets/8df17bfa-141c-4f00-9412-5d3f6131574f
 
-**Requirements for authentication:**
-- A client application configured in your eGain tenant (some environments may have a pre-configured **APIs Trial** client app)
-- A supported browser (Chrome, Edge, or Brave — Safari is not supported)
-- Delegated API permissions in your client app:
-  - `knowledge.portalmgr.manage`
-  - `knowledge.portalmgr.read`
-  - `core.aiservices.read`
+On your first MCP query, a browser window will open for authentication.
 
-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.
+Enter your authentication configuration values in the browser form. For details, 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/) — **select SPA (Single Page Application) as the platform type**.
 
 <!-- No Installation [installation] -->
 
-## 🆘 Having Issues?
-
-Start here — most problems are covered in the FAQ:
-
-- **[FAQ & Troubleshooting](./help/faq.md)**
-- Authentication issues → [Authentication FAQ](./help/faq.md#authentication-issues)
-- Configuration issues → [Configuration FAQ](./help/faq.md#configuration-issues)
-- MCP tool issues → [Tool FAQ](./help/faq.md#mcp-tool-issues)
-
-### Token issues (expired or stuck)
-
-If authentication fails after it previously worked, delete cached token files and retry:
-
-```bash
-# Search your home directory for both token files
-find ~ -name ".bearer_token*" 2>/dev/null
-# Remove both token files
-rm /path/to/.bearer_token*
-```
-
 ## Debugging
 
 Use the MCP Inspector for interactive testing:

package/bin/mcp-server.js

@@ -4046,9 +4046,9 @@ var init_config = __esm(() => {
   SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "1.0.0",
-    sdkVersion: "1.0.24",
+    sdkVersion: "1.0.25",
     genVersion: "2.723.8",
-    userAgent: "speakeasy-sdk/mcp-typescript 1.0.24 2.723.8 1.0.0 @egain/egain-mcp-server"
+    userAgent: "speakeasy-sdk/mcp-typescript 1.0.25 2.723.8 1.0.0 @egain/egain-mcp-server"
   };
 });
 
@@ -44798,24 +44798,13 @@ var init_acceptlanguage = __esm(() => {
 });
 
 // src/models/articletype.ts
-var TypeName$zodSchema, ArticleType$zodSchema;
+var ArticleType$zodSchema;
 var init_articletype = __esm(() => {
   init_zod();
-  TypeName$zodSchema = enumType([
-    "General",
-    "Guided Help",
-    "Data Link",
-    "PDF Content",
-    "Topic Home",
-    "Suggestion",
-    "Virtual Assistant Action",
-    "Rich Message",
-    "Library Content"
-  ]).describe("Indicates the article category name.");
   ArticleType$zodSchema = objectType({
     articleCategoryId: numberType().int().optional(),
     articleTypeId: stringType().optional(),
-    typeName: TypeName$zodSchema.optional(),
+    typeName: stringType().optional(),
     useStructuredAuthoring: booleanType().optional()
   }).describe("The type of the Article and its attributes.");
 });
@@ -45400,9 +45389,47 @@ var init_getAnnouncements2 = __esm(() => {
 
 Get Announcements
 
+## How to Use This Tool
+
+**CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
+
+**Parameter Format**: 
+- Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999"}}\`
+- Required parameter: \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
+- Optional parameters:
+  - \`Dollar_lang\` (string, default: "en-US") - Language code
+  - \`acceptLanguage\` (string, default: "en-US") - Accept-Language header value
+  - \`dollarFilterTags\` (string) - Comma-separated list of Tag/Tag Group IDs
+  - \`workflowMilestone\` (string) - Workflow milestone filter ("authoring", "staging", "publish")
+  - \`Dollar_pagenum\` (number, default: 1) - Page number for pagination
+  - \`Dollar_pagesize\` (number, default: 10) - Number of results per page
+
+**Example**: To get announcements from portal "PZ-9999", call with:
+\`\`\`json
+{"request": {"portalID": "PZ-9999"}}
+\`\`\`
+
+**Example with optional parameters**:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "Dollar_lang": "en-US", "Dollar_pagesize": 20}}
+\`\`\`
+
+## Displaying Results (MCP-Specific)
+**CRITICAL**: When this tool returns data successfully, you MUST display the announcement articles to the user in your response. Do not silently process the data - always show the user what was returned.
+
+**What to display:**
+- Display all announcement articles with their names and IDs
+- Show the article content (\`content\` or \`contentText\`) for each announcement
+- Display metadata such as \`createdDate\`, \`modifiedDate\`, \`articleSummary\`
+- Show \`attachments\` if present
+- Include \`paginationInfo\` if pagination is used
+- Format announcements in a clear list format
+
+**Example**: "Here are the announcements for this portal: 1) [Announcement Name] (ID: PROD-123) - [content]..."
+
 ## Prerequisites
 - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
-- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
+- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "PROD-1004")
 
 ## Overview
 The Get Announcements API allows a user to retrieve all announcement articles for a specific portal. Announcements are special articles that are prominently displayed to users and typically contain important updates, news, or notifications.
@@ -45831,6 +45858,48 @@ var init_getArticle2 = __esm(() => {
 
 Get Article by ID
 
+## How to Use This Tool
+
+**CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
+
+**Parameter Format**: 
+- Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "articleID": "PROD-2996"}}\`
+- Required parameters:
+  - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
+  - \`articleID\` (string) - The article ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PROD-2996")
+- Optional parameters:
+  - \`Dollar_lang\` (string, default: "en-US") - Language code
+  - \`acceptLanguage\` (string, default: "en-US") - Accept-Language header value
+  - \`articleAdditionalAttributes\` (array) - Additional article attributes to return
+  - \`Dollar_customAdditionalAttributes\` (string) - Custom additional attributes
+  - \`accessSource\` (string, default: "article_view") - How the article was accessed
+  - \`publishViewId\` (string) - Publish view ID
+  - \`workflowMilestone\` (string) - Workflow milestone filter
+
+**Example**: To get article "PROD-2996" from portal "PZ-9999", call with:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "articleID": "PROD-2996"}}
+\`\`\`
+
+**Example with optional parameters**:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "articleID": "PROD-2996", "Dollar_lang": "en-US", "accessSource": "article_view"}}
+\`\`\`
+
+## Displaying Results (MCP-Specific)
+**CRITICAL**: When this tool returns data successfully, you MUST display the article content to the user in your response. Do not silently process the data - always show the user what was returned.
+
+**What to display:**
+- Display the article \`name\` as the title
+- Show the article \`content\` or \`contentText\` (the full article body)
+- Display article metadata: \`id\`, \`articleType\`, \`createdDate\`, \`modifiedDate\`
+- Show \`attachments\` if present
+- Display \`topicBreadcrumb\` to show where the article is categorized
+- Include any other relevant metadata like \`articleSummary\`, \`description\`, \`articleKeywords\`
+- Format the article content in a readable way for the user
+
+**Example**: "Here's the article '[Article Name]' (ID: PROD-2996): [article content]. This article is categorized under: [topic breadcrumb]..."
+
 ## Prerequisites
 - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
 - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
@@ -45998,6 +46067,43 @@ var init_getPopularArticles2 = __esm(() => {
 
 Get Popular Articles
 
+## How to Use This Tool
+
+**CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
+
+**Parameter Format**: 
+- Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999"}}\`
+- Required parameter: \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
+- Optional parameters:
+  - \`Dollar_lang\` (string, default: "en-US") - Language code
+  - \`Dollar_pagenum\` (number, default: 1) - Page number for pagination
+  - \`Dollar_pagesize\` (number, default: 10) - Number of results per page
+  - \`dollarFilterTopicId\` (string) - Filter by topic ID
+  - \`dollarFilterTags\` (string) - Comma-separated list of Tag/Tag Group IDs
+
+**Example**: To get popular articles from portal "PZ-9999", call with:
+\`\`\`json
+{"request": {"portalID": "PZ-9999"}}
+\`\`\`
+
+**Example with optional parameters**:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "Dollar_lang": "en-US", "Dollar_pagesize": 20}}
+\`\`\`
+
+## Displaying Results (MCP-Specific)
+**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.
+
+**What to display:**
+- Display all popular articles with their names and IDs
+- Show article summaries or descriptions when available
+- Display metadata such as \`articleType\`, \`createdDate\`, \`modifiedDate\`
+- Show \`imageURL\` if available (mention thumbnail availability)
+- Include \`paginationInfo\` if pagination is used
+- Format articles in a numbered or bulleted list
+
+**Example**: "Here are the most popular articles: 1) [Article Name] (ID: PROD-123) - [summary]..."
+
 ## Prerequisites
 - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
 - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
@@ -46077,56 +46183,6 @@ var init_allaccessibleportals = __esm(() => {
   }).describe("Success");
 });
 
-// src/models/mandatorylanguagequeryparameter.ts
-var MandatoryLanguageQueryParameter$zodSchema;
-var init_mandatorylanguagequeryparameter = __esm(() => {
-  init_zod();
-  MandatoryLanguageQueryParameter$zodSchema = enumType([
-    "en-US",
-    "fr-FR",
-    "en-GB",
-    "es-ES",
-    "it-IT",
-    "nl-NL",
-    "da-DA",
-    "sv-SE",
-    "pt-PT",
-    "fi-FI",
-    "no-NB",
-    "no-NN",
-    "ja-JA",
-    "de-DE",
-    "pt-BR",
-    "zh-CN",
-    "zh-TW",
-    "ko-KO",
-    "ru-RU",
-    "el-EL",
-    "tr-TR",
-    "pl-PL",
-    "cs-CS",
-    "sk-SK",
-    "hu-HU",
-    "sr-SR",
-    "ar-SA",
-    "hr-HR",
-    "ro-RO",
-    "th-TH",
-    "de-AT",
-    "vi-VN",
-    "id-ID",
-    "ms-MY",
-    "fil-PH",
-    "fr-CA",
-    "hi-IN",
-    "uk-UA",
-    "bg-BG",
-    "sl-SI",
-    "sr-RS",
-    "xx-XX"
-  ]).describe("The language used for fetching the details of a resource. Resources available in different languages may differ from each other. **Important**: When using this API via SDK or MCP, use the parameter name `Dollar_lang`, not `$lang` or `lang`.");
-});
-
 // src/models/order.ts
 var Order$zodSchema;
 var init_order = __esm(() => {
@@ -46154,12 +46210,12 @@ var init_getmyportalsop = __esm(() => {
   init_zod();
   init_acceptlanguage();
   init_allaccessibleportals();
-  init_mandatorylanguagequeryparameter();
+  init_languagequeryparameter();
   init_order();
   init_sortidnamedepartment();
   init_wserrorcommon();
   GetMyPortalsRequest$zodSchema = objectType({
-    Dollar_lang: MandatoryLanguageQueryParameter$zodSchema,
+    Dollar_lang: LanguageQueryParameter$zodSchema.default("en-US"),
     Dollar_order: Order$zodSchema.optional(),
     Dollar_pagenum: numberType().int().default(1).describe("Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize."),
     Dollar_pagesize: numberType().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"),
@@ -46183,7 +46239,7 @@ function getPortals(client$, request, options) {
   return new APIPromise($do4(client$, request, options));
 }
 async function $do4(client$, request, options) {
-  const parsed$ = safeParse(request, (value$) => GetMyPortalsRequest$zodSchema.parse(value$), "Input validation failed");
+  const parsed$ = safeParse(request, (value$) => GetMyPortalsRequest$zodSchema.optional().parse(value$), "Input validation failed");
   if (!parsed$.ok) {
     return [parsed$, { status: "invalid" }];
   }
@@ -46191,18 +46247,18 @@ async function $do4(client$, request, options) {
   const body$ = null;
   const path$ = pathToFunc("/myportals")();
   const query$ = encodeFormQuery({
-    $lang: payload$.Dollar_lang,
-    $order: payload$.Dollar_order,
-    $pagenum: payload$.Dollar_pagenum,
-    $pagesize: payload$.Dollar_pagesize,
-    $sort: payload$.Dollar_sort,
-    department: payload$.department,
-    filterText: payload$.filterText,
-    shortUrlTemplate: payload$.shortUrlTemplate
+    $lang: payload$?.Dollar_lang,
+    $order: payload$?.Dollar_order,
+    $pagenum: payload$?.Dollar_pagenum,
+    $pagesize: payload$?.Dollar_pagesize,
+    $sort: payload$?.Dollar_sort,
+    department: payload$?.department,
+    filterText: payload$?.filterText,
+    shortUrlTemplate: payload$?.shortUrlTemplate
   });
   const headers$ = new Headers(compactMap({
     Accept: "application/json",
-    "Accept-Language": encodeSimple("Accept-Language", payload$.acceptLanguage, { explode: false, charEncoding: "none" })
+    "Accept-Language": encodeSimple("Accept-Language", payload$?.acceptLanguage, { explode: false, charEncoding: "none" })
   }));
   const securityInput = await extractSecurity(client$._options.security);
   const requestSecurity = resolveGlobalSecurity(securityInput);
@@ -46275,7 +46331,7 @@ var init_getPortals2 = __esm(() => {
   init_getmyportalsop();
   init_tools();
   args4 = {
-    request: GetMyPortalsRequest$zodSchema
+    request: GetMyPortalsRequest$zodSchema.optional()
   };
   tool$getPortals = {
     name: "get-portals",
@@ -46283,6 +46339,15 @@ var init_getPortals2 = __esm(() => {
 
 Get All Portals Accessible to User
 
+## How to Use This Tool
+
+**Parameter Format**: This tool requires a \`request\` parameter containing the request object.
+- **CRITICAL**: All parameters in this tool are optional. You may pass an empty request object: \`{"request": {}}\`
+- If you want to specify a language, pass: \`{"request": {"Dollar_lang": "en-US"}}\`
+- The \`Dollar_lang\` parameter is **optional** - if omitted, the API defaults to "en-US"
+- **Example with empty request** (recommended if you don't need to specify language): \`{"request": {}}\`
+- **Example with language**: \`{"request": {"Dollar_lang": "en-US"}}\`
+
 ## Overview
 The Get All Portals Accessible to User API allows a user to fetch all portals accessible to the user across all departments.
 - If no access tags are specified for a portal, any user can access the portal.
@@ -46330,6 +46395,22 @@ If you search for "business portal" and the first page returns 25 portals but no
 - Search the complete merged list before concluding the portal doesn't exist
 
 This ensures reliable portal name-to-ID resolution and prevents false "not found" errors.
+
+## Displaying Results (MCP-Specific)
+**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.
+
+**What to display:**
+- Display all portals with their names and IDs
+- Show portal \`id\` (the portal ID needed for other API calls)
+- Display portal \`name\` (the human-readable portal name)
+- Show \`departmentName\` if available
+- Include \`shortURL\` if available
+- Display \`paginationInfo\` to show total count and current page
+- Format portals in a clear list format (e.g., "Portal Name (ID: PORTAL-123)")
+
+**Example**: "Here are the available portals: 1) Business Portal (ID: PORTAL-123), 2) Customer Portal (ID: PORTAL-456)..."
+
+**Important**: Always display portal IDs clearly, as users will need these IDs to call other tools.
 `,
     annotations: {
       destructiveHint: false,
@@ -46538,6 +46619,48 @@ var init_makeSuggestion2 = __esm(() => {
 
 Make a Suggestion
 
+## How to Use This Tool
+
+**CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
+
+**Parameter Format**: 
+- Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "CreateSuggestion": {...}}}\`
+- Required parameters:
+  - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
+  - \`CreateSuggestion\` (object) - The suggestion object with:
+    - \`name\` (string, **required**) - Name/title of the suggestion
+    - \`content\` (string, **required**) - Content/description of the suggestion
+    - \`language\` (object, **required**) - Language object with \`code\` property (e.g., {"code": "en-US"})
+- Optional parameters:
+  - \`acceptLanguage\` (string, default: "en-US") - Accept-Language header value
+  - \`CreateSuggestion\` additional optional fields:
+    - \`description\` (string) - Additional description
+    - \`feedbackArticle\` (object) - Article ID object if providing feedback on existing article: \`{"id": "PROD-2996"}\`
+    - \`attachments\` (object) - Attachments object
+    - \`customAttributes\` (array) - Custom attributes array
+
+**Example**: To create a suggestion in portal "PZ-9999", call with:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "CreateSuggestion": {"name": "New Article Request", "content": "Please add information about loan rates", "language": {"code": "en-US"}}}}
+\`\`\`
+
+**Example with feedback on existing article**:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "CreateSuggestion": {"name": "Article Feedback", "content": "This article needs updating", "language": {"code": "en-US"}, "feedbackArticle": {"id": "PROD-2996"}}}}
+\`\`\`
+
+## Displaying Results (MCP-Specific)
+**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.
+
+**What to display:**
+- Confirm that the suggestion was successfully created
+- Display the suggestion \`id\` if returned in the response
+- Show the suggestion \`name\` and \`content\` that was submitted
+- If an error occurs, display the error message clearly
+- Provide confirmation message to the user
+
+**Example**: "Your suggestion '[Suggestion Name]' has been successfully submitted. Suggestion ID: [id]..."
+
 ## Prerequisites
 - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
 - Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
@@ -46885,18 +47008,54 @@ var init_queryAnswers2 = __esm(() => {
 
 Get Answers
 
+## How to Use This Tool
+
+**CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
+
+**Parameter Format**: 
+- Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}\`
+- Required parameters:
+  - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
+  - \`q\` (string) - The search query string
+  - \`Dollar_lang\` (string) - Language code (e.g., "en-US")
+- Optional parameters:
+  - \`dollarFilterUserProfileID\` (string) - User profile ID filter
+  - \`dollarFilterTags\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
+  - \`dollarFilterTopicIds\` (array) - Array of topic IDs to filter by
+  - \`AnswersRequest\` (object) - Request body parameters:
+    - \`eventId\` (string, **required**) - Event ID
+    - \`sessionId\` (string, **required**) - Session ID
+    - \`channel\` (object, **optional**, recommended to omit) - Channel information. Omit unless specifically needed. If you receive a 400 error with channel, retry without it.
+    - \`context\` (object) - Additional context (companyContext, pageContext, userContext)
+
+**Example**: To get answers for query "loan information" from portal "PZ-9999", call with:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "AnswersRequest": {"eventId": "event-123", "sessionId": "session-456"}}}
+\`\`\`
+
+**Note**: The \`channel\` field in \`AnswersRequest\` is optional and recommended to omit unless specifically needed. The API works reliably without it.
+
+## Displaying Results (MCP-Specific)
+**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.
+
+**What to display:**
+- Display the \`answer.answerValue\` text prominently as the main answer to the user's query
+- Indicate the answer type (\`answerType\`: "certified" or "generative")
+- If \`relevanceScore\` is present, you may mention the confidence level
+- List all \`references\` (article IDs and names) that were used to generate the answer
+- Display \`searchResults\` showing related articles with their names, IDs, snippets, and relevance scores
+- Format the answer in a clear, readable way - this is the primary response the user is seeking
+
+**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]..."
+
 ## Prerequisites
 - Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.
-- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
+- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "PROD-1004")
 
 ## Overview
 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.
 
 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.
-
-## Request Body Notes
-- **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.
-- **Required fields**: eventId and sessionId are required in the request body.
 `,
     annotations: {
       destructiveHint: false,
@@ -47107,9 +47266,49 @@ var init_queryRetrieve2 = __esm(() => {
 
 Retrieve Chunks
 
+## How to Use This Tool
+
+**CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
+
+**Parameter Format**: 
+- Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}\`
+- Required parameters:
+  - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
+  - \`q\` (string) - The search query string
+  - \`Dollar_lang\` (string) - Language code (e.g., "en-US")
+- Optional parameters:
+  - \`dollarFilterUserProfileID\` (string) - User profile ID filter
+  - \`dollarFilterTags\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
+  - \`dollarFilterTopicIds\` (array) - Array of topic IDs to filter by
+  - \`RetrieveRequest\` (object) - Additional request body parameters:
+    - \`channel\` (object) - Channel information (optional, recommended to omit)
+    - \`eventId\` (string) - Event ID
+    - \`sessionId\` (string) - Session ID
+
+**Example**: To retrieve chunks for query "loan information" from portal "PZ-9999", call with:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US"}}
+\`\`\`
+
+**Example with RetrieveRequest body**:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "RetrieveRequest": {"eventId": "event-123", "sessionId": "session-456"}}}
+\`\`\`
+
+## Displaying Results (MCP-Specific)
+**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.
+
+**What to display:**
+- If a certified answer is returned (\`answer\` object), display the \`answerValue\` text and list the \`references\` (article IDs and names)
+- Display all \`searchResults\` with their article names, IDs, snippets, and relevance scores (\`normalizedScore\`)
+- Show article metadata such as \`docType\`, \`source\`, and \`topicBreadcrumb\` when available
+- Format the results in a user-friendly way (e.g., numbered list, formatted text)
+
+**Example**: "I found 5 relevant articles about loan information: 1) [Article Name] (ID: PROD-123) - [snippet]..."
+
 ## Prerequisites
 - **Requires a valid portal ID** (required parameter). If you don't have the portal ID, first call 'get-portals' to get available portals.
-- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "EB-123456789")
+- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., "PROD-1004")
 
 ## Overview
 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.
@@ -47446,7 +47645,54 @@ var init_querySearch2 = __esm(() => {
     name: "query-search",
     description: `Hybrid Search
 
-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.**
+Hybrid Search
+
+## How to Use This Tool
+
+**CRITICAL**: This tool requires a \`request\` parameter containing the request object. All parameters must be passed inside a \`request\` object.
+
+**Parameter Format**: 
+- Always wrap parameters in a \`request\` object: \`{"request": {"portalID": "PZ-9999", "q": "loan information"}}\`
+- Required parameters:
+  - \`portalID\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., "PZ-9999")
+  - \`q\` (string) - The search query string (must be URL-escaped)
+- Optional parameters:
+  - \`Dollar_lang\` (string, default: "en-US") - Language code
+  - \`dollarFilterUserProfileID\` (string) - User profile ID filter
+  - \`dollarFilterTags\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs
+  - \`dollarFilterTopicIds\` (array) - Array of topic IDs to filter by
+  - \`articleCustomAdditionalAttributes\` (string) - Comma-separated custom attribute names
+  - \`Dollar_pagenum\` (number, default: 1) - Page number for pagination
+  - \`Dollar_pagesize\` (number, default: 20) - Number of results per page
+
+**Example**: To search for "loan information" in portal "PZ-9999", call with:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "q": "loan information"}}
+\`\`\`
+
+**Example with optional parameters**:
+\`\`\`json
+{"request": {"portalID": "PZ-9999", "q": "loan information", "Dollar_lang": "en-US", "Dollar_pagesize": 25}}
+\`\`\`
+
+**Note**: This endpoint is only available for Self Service environments.
+
+## Displaying Results (MCP-Specific)
+**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.
+
+**What to display:**
+- Display all search results with article names and IDs
+- Show article \`snippet\` or \`keywordSnippet\` (the relevant text excerpt)
+- Display \`normalizedScore\` or \`relevanceScore\` to indicate relevance
+- Show \`docType\`, \`source\`, and \`topicBreadcrumb\` metadata
+- Display \`contextualSummary\` if available
+- Include \`paginationInfo\` if pagination is used
+- Format results in a numbered list with clear relevance indicators
+
+**Example**: "I found 10 articles matching 'loan information': 1) [Article Name] (ID: PROD-123) - [snippet] (Relevance: 0.89)..."
+
+## Overview
+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.
 `,
     annotations: {
       destructiveHint: false,
@@ -47473,7 +47719,7 @@ The Search API is a hybrid search service that combines semantic understanding w
 function createMCPServer(deps) {
   const server = new McpServer({
     name: "EgainMcp",
-    version: "1.0.24"
+    version: "1.0.25"
   });
   const getClient = deps.getSDK || (() => new EgainMcpCore({
     security: deps.security,
@@ -48720,7 +48966,7 @@ var routes = ln({
 var app = _e(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "1.0.24"
+    currentVersion: "1.0.25"
   }
 });
 Yt(app, process3.argv.slice(2), buildContext(process3));
@@ -48728,5 +48974,5 @@ export {
   app
 };
 
-//# debugId=BD1B9CC5744D3D7D64756E2164756E21
+//# debugId=96750509ECBCF97D64756E2164756E21
 //# sourceMappingURL=mcp-server.js.map