@egain/egain-mcp-server 1.0.26 → 1.0.27

package/manifest.json

@@ -1,9 +1,9 @@
 {
   "dxt_version": "0.1",
   "name": "@egain/egain-mcp-server",
-  "version": "1.0.24",
+  "version": "1.0.25",
   "description": "",
-  "long_description": "eGain Portal, Retrieve, Search, Answers APIs: Enterprise knowledge APIs for managing portals, searching content, retrieving AI-powered answers, and accessing content chunks for custom integrations.",
+  "long_description": "eGain Portal, Retrieve, Search, Answers APIs: Enterprise knowledge APIs for managing portals, searching content, retrieving AI-powered answers, and accessing content chunks for custom integrations.\n\n## How to Use eGain MCP Tools\n\n**IMPORTANT**: When calling eGain MCP tools, you must provide all required parameters in the correct format.\n\n### Parameter Format\n- **All tools require a `request` parameter** that contains the actual request object\n- The `request` parameter is an object that wraps all the API-specific parameters\n- **Example**: To call `get-portals`, pass: `{\"request\": {\"$lang\": \"en-US\"}}`\n- **Example**: To call `get-article`, pass: `{\"request\": {\"portalID\": \"PROD-1004\", \"articleID\": \"PROD-2996\"}}`\n\n### Tools That Require No Parameters\n- Some tools may accept an empty request object `{}` if all parameters are optional\n- Always check the tool schema for exact requirements\n- If a tool has required parameters, they must be provided in the `request` object\n\n### Common Patterns\n1. **Portal ID is often required**: Most tools need a `portalID`. Use `get-portals` first to find available portals\n2. **Language parameter**: Many tools accept `$lang` (use `Dollar_lang` in the request object) with default \"en-US\"\n3. **Request body**: For POST endpoints, include the request body fields inside the `request` object\n\n### Error Prevention\n- Always provide the `request` parameter, even if it's an empty object `{}`\n- Ensure all required fields are present in the `request` object\n- Check the tool schema to understand the exact structure expected\n",
   "author": {
     "name": "Emily Loh - eGain Corporation"
   },
@@ -28,35 +28,35 @@
   "tools": [
     {
       "name": "query-retrieve",
-      "description": "Retrieve Chunks\n\nRetrieve Chunks\n\n## Prerequisites\n- **Requires a valid portal ID** (required parameter). If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe 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.\n\nIn addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility.\n\nBy leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.\n"
+      "description": "Retrieve Chunks\n\nRetrieve Chunks\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a \\`request\\` parameter containing the request object. All parameters must be passed inside a \\`request\\` object.\n\n**Parameter Format**: \n- Always wrap parameters in a \\`request\\` object: \\`{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\"}}\\`\n- Required parameters:\n  - \\`portalID\\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - \\`q\\` (string) - The search query string\n  - \\`Dollar_lang\\` (string) - Language code (e.g., \"en-US\")\n- Optional parameters:\n  - \\`dollarFilterUserProfileID\\` (string) - User profile ID filter\n  - \\`dollarFilterTags\\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs\n  - \\`dollarFilterTopicIds\\` (array) - Array of topic IDs to filter by\n  - \\`RetrieveRequest\\` (object) - Additional request body parameters:\n    - \\`channel\\` (object) - Channel information (optional, recommended to omit)\n    - \\`eventId\\` (string) - Event ID\n    - \\`sessionId\\` (string) - Session ID\n\n**Example**: To retrieve chunks for query \"loan information\" from portal \"PZ-9999\", call with:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\"}}\n\\`\\`\\`\n\n**Example with RetrieveRequest body**:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\", \"RetrieveRequest\": {\"eventId\": \"event-123\", \"sessionId\": \"session-456\"}}}\n\\`\\`\\`\n\n## Displaying Results (MCP-Specific)\n**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.\n\n**What to display:**\n- If a certified answer is returned (\\`answer\\` object), display the \\`answerValue\\` text and list the \\`references\\` (article IDs and names)\n- Display all \\`searchResults\\` with their article names, IDs, snippets, and relevance scores (\\`normalizedScore\\`)\n- Show article metadata such as \\`docType\\`, \\`source\\`, and \\`topicBreadcrumb\\` when available\n- Format the results in a user-friendly way (e.g., numbered list, formatted text)\n\n**Example**: \"I found 5 relevant articles about loan information: 1) [Article Name] (ID: PROD-123) - [snippet]...\"\n\n## Prerequisites\n- **Requires a valid portal ID** (required parameter). If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-1004\")\n\n## Overview\nThe 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.\n\nIn addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility.\n\nBy leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.\n"
     },
     {
       "name": "query-answers",
-      "description": "Generate an Answer\n\nGet Answers\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe 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.\n\nThe 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.\n\n## Request Body Notes\n- **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.\n- **Required fields**: eventId and sessionId are required in the request body.\n"
+      "description": "Generate an Answer\n\nGet Answers\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a \\`request\\` parameter containing the request object. All parameters must be passed inside a \\`request\\` object.\n\n**Parameter Format**: \n- Always wrap parameters in a \\`request\\` object: \\`{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\"}}\\`\n- Required parameters:\n  - \\`portalID\\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - \\`q\\` (string) - The search query string\n  - \\`Dollar_lang\\` (string) - Language code (e.g., \"en-US\")\n- Optional parameters:\n  - \\`dollarFilterUserProfileID\\` (string) - User profile ID filter\n  - \\`dollarFilterTags\\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs\n  - \\`dollarFilterTopicIds\\` (array) - Array of topic IDs to filter by\n  - \\`AnswersRequest\\` (object) - Request body parameters:\n    - \\`eventId\\` (string, **required**) - Event ID\n    - \\`sessionId\\` (string, **required**) - Session ID\n    - \\`channel\\` (object, **optional**, recommended to omit) - Channel information. Omit unless specifically needed. If you receive a 400 error with channel, retry without it.\n    - \\`context\\` (object) - Additional context (companyContext, pageContext, userContext)\n\n**Example**: To get answers for query \"loan information\" from portal \"PZ-9999\", call with:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\", \"AnswersRequest\": {\"eventId\": \"event-123\", \"sessionId\": \"session-456\"}}}\n\\`\\`\\`\n\n**Note**: The \\`channel\\` field in \\`AnswersRequest\\` is optional and recommended to omit unless specifically needed. The API works reliably without it.\n\n## Displaying Results (MCP-Specific)\n**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.\n\n**What to display:**\n- Display the \\`answer.answerValue\\` text prominently as the main answer to the user's query\n- Indicate the answer type (\\`answerType\\`: \"certified\" or \"generative\")\n- If \\`relevanceScore\\` is present, you may mention the confidence level\n- List all \\`references\\` (article IDs and names) that were used to generate the answer\n- Display \\`searchResults\\` showing related articles with their names, IDs, snippets, and relevance scores\n- Format the answer in a clear, readable way - this is the primary response the user is seeking\n\n**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]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-1004\")\n\n## Overview\nThe 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.\n\nThe 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.\n"
     },
     {
       "name": "get-article",
-      "description": "Get Article by ID\n\nGet Article by ID\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n- Requires a valid article ID. Article ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-2996\")\n\n## Overview\nThe Get Article by ID API allows a user to retrieve a specific article using its ID. Additional article attributes and contextual views can be specified in the query parameters.\n\nThis API returns structured authoring attributes of Issue, Environment, Cause and Confidence Level when the following conditions are met:\n- The \"Allow Structured Authoring\" setting is enabled at the partition/department level\n- The \"Use Structured Authoring\" flag is set on the article type\n"
+      "description": "Get Article by ID\n\nGet Article by ID\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a \\`request\\` parameter containing the request object. All parameters must be passed inside a \\`request\\` object.\n\n**Parameter Format**: \n- Always wrap parameters in a \\`request\\` object: \\`{\"request\": {\"portalID\": \"PZ-9999\", \"articleID\": \"PROD-2996\"}}\\`\n- Required parameters:\n  - \\`portalID\\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - \\`articleID\\` (string) - The article ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PROD-2996\")\n- Optional parameters:\n  - \\`Dollar_lang\\` (string, default: \"en-US\") - Language code\n  - \\`acceptLanguage\\` (string, default: \"en-US\") - Accept-Language header value\n  - \\`articleAdditionalAttributes\\` (array) - Additional article attributes to return\n  - \\`Dollar_customAdditionalAttributes\\` (string) - Custom additional attributes\n  - \\`accessSource\\` (string, default: \"article_view\") - How the article was accessed\n  - \\`publishViewId\\` (string) - Publish view ID\n  - \\`workflowMilestone\\` (string) - Workflow milestone filter\n\n**Example**: To get article \"PROD-2996\" from portal \"PZ-9999\", call with:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"articleID\": \"PROD-2996\"}}\n\\`\\`\\`\n\n**Example with optional parameters**:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"articleID\": \"PROD-2996\", \"Dollar_lang\": \"en-US\", \"accessSource\": \"article_view\"}}\n\\`\\`\\`\n\n## Displaying Results (MCP-Specific)\n**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.\n\n**What to display:**\n- Display the article \\`name\\` as the title\n- Show the article \\`content\\` or \\`contentText\\` (the full article body)\n- Display article metadata: \\`id\\`, \\`articleType\\`, \\`createdDate\\`, \\`modifiedDate\\`\n- Show \\`attachments\\` if present\n- Display \\`topicBreadcrumb\\` to show where the article is categorized\n- Include any other relevant metadata like \\`articleSummary\\`, \\`description\\`, \\`articleKeywords\\`\n- Format the article content in a readable way for the user\n\n**Example**: \"Here's the article '[Article Name]' (ID: PROD-2996): [article content]. This article is categorized under: [topic breadcrumb]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n- Requires a valid article ID. Article ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-2996\")\n\n## Overview\nThe Get Article by ID API allows a user to retrieve a specific article using its ID. Additional article attributes and contextual views can be specified in the query parameters.\n\nThis API returns structured authoring attributes of Issue, Environment, Cause and Confidence Level when the following conditions are met:\n- The \"Allow Structured Authoring\" setting is enabled at the partition/department level\n- The \"Use Structured Authoring\" flag is set on the article type\n"
     },
     {
       "name": "get-announcements",
-      "description": "Get Announcement Articles\n\nGet Announcements\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe 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.\n\nThis API returns announcement articles with their full content, metadata, and any associated attachments or links.\n"
+      "description": "Get Announcement Articles\n\nGet Announcements\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a \\`request\\` parameter containing the request object. All parameters must be passed inside a \\`request\\` object.\n\n**Parameter Format**: \n- Always wrap parameters in a \\`request\\` object: \\`{\"request\": {\"portalID\": \"PZ-9999\"}}\\`\n- Required parameter: \\`portalID\\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n- Optional parameters:\n  - \\`Dollar_lang\\` (string, default: \"en-US\") - Language code\n  - \\`acceptLanguage\\` (string, default: \"en-US\") - Accept-Language header value\n  - \\`dollarFilterTags\\` (string) - Comma-separated list of Tag/Tag Group IDs\n  - \\`workflowMilestone\\` (string) - Workflow milestone filter (\"authoring\", \"staging\", \"publish\")\n  - \\`Dollar_pagenum\\` (number, default: 1) - Page number for pagination\n  - \\`Dollar_pagesize\\` (number, default: 10) - Number of results per page\n\n**Example**: To get announcements from portal \"PZ-9999\", call with:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\"}}\n\\`\\`\\`\n\n**Example with optional parameters**:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"Dollar_lang\": \"en-US\", \"Dollar_pagesize\": 20}}\n\\`\\`\\`\n\n## Displaying Results (MCP-Specific)\n**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.\n\n**What to display:**\n- Display all announcement articles with their names and IDs\n- Show the article content (\\`content\\` or \\`contentText\\`) for each announcement\n- Display metadata such as \\`createdDate\\`, \\`modifiedDate\\`, \\`articleSummary\\`\n- Show \\`attachments\\` if present\n- Include \\`paginationInfo\\` if pagination is used\n- Format announcements in a clear list format\n\n**Example**: \"Here are the announcements for this portal: 1) [Announcement Name] (ID: PROD-123) - [content]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-1004\")\n\n## Overview\nThe 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.\n\nThis API returns announcement articles with their full content, metadata, and any associated attachments or links.\n"
     },
     {
       "name": "get-popular-articles",
-      "description": "Get Popular Articles\n\nGet Popular Articles\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Popular Articles API allows a user to retrieve the most popular articles from a specific portal. Popular articles are typically determined by user engagement metrics such as views, ratings, or usage frequency.\n\nThis API returns a list of popular articles with their metadata, allowing users to discover the most relevant and frequently accessed content within the portal.\n"
+      "description": "Get Popular Articles\n\nGet Popular Articles\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a \\`request\\` parameter containing the request object. All parameters must be passed inside a \\`request\\` object.\n\n**Parameter Format**: \n- Always wrap parameters in a \\`request\\` object: \\`{\"request\": {\"portalID\": \"PZ-9999\"}}\\`\n- Required parameter: \\`portalID\\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n- Optional parameters:\n  - \\`Dollar_lang\\` (string, default: \"en-US\") - Language code\n  - \\`Dollar_pagenum\\` (number, default: 1) - Page number for pagination\n  - \\`Dollar_pagesize\\` (number, default: 10) - Number of results per page\n  - \\`dollarFilterTopicId\\` (string) - Filter by topic ID\n  - \\`dollarFilterTags\\` (string) - Comma-separated list of Tag/Tag Group IDs\n\n**Example**: To get popular articles from portal \"PZ-9999\", call with:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\"}}\n\\`\\`\\`\n\n**Example with optional parameters**:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"Dollar_lang\": \"en-US\", \"Dollar_pagesize\": 20}}\n\\`\\`\\`\n\n## Displaying Results (MCP-Specific)\n**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.\n\n**What to display:**\n- Display all popular articles with their names and IDs\n- Show article summaries or descriptions when available\n- Display metadata such as \\`articleType\\`, \\`createdDate\\`, \\`modifiedDate\\`\n- Show \\`imageURL\\` if available (mention thumbnail availability)\n- Include \\`paginationInfo\\` if pagination is used\n- Format articles in a numbered or bulleted list\n\n**Example**: \"Here are the most popular articles: 1) [Article Name] (ID: PROD-123) - [summary]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Popular Articles API allows a user to retrieve the most popular articles from a specific portal. Popular articles are typically determined by user engagement metrics such as views, ratings, or usage frequency.\n\nThis API returns a list of popular articles with their metadata, allowing users to discover the most relevant and frequently accessed content within the portal.\n"
     },
     {
       "name": "get-portals",
-      "description": "Get All Portals Accessible To User\n\nGet All Portals Accessible to User\n\n## Overview\nThe Get All Portals Accessible to User API allows a user to fetch all portals accessible to the user across all departments.\n- If no access tags are specified for a portal, any user can access the portal.\n- If access tags are specified for a portal, users with a user profile that allows access can access the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile.\n- Global users (partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.\n- The only articles returned are associated to an Article type when the parameter “Include in browse on portals” is set to \"Yes\".\n- When the \\`shortUrlTemplate\\` query parameter is provided, the API filters accessible portals according to the specified language and template name. A portal short URL specific to the \\`shortUrlTemplate\\` value is returned in the response when available. If there is no short URL for a language, the portal object returns an empty \\`shortURL\\` field.\n\n## Pagination behavior (CRITICAL for AI assistants)\n\n**IMPORTANT**: This endpoint is paginated. When searching for a portal by name or listing portals, you MUST automatically fetch ALL pages before concluding that a portal doesn't exist.\n\n### Automatic pagination is REQUIRED when:\n- User asks to find a portal by name (e.g., \"business portal\", \"Master portal\")\n- User requests to list or see all portals\n- You need to resolve a natural portal name to its ID\n\n### How to detect more pages exist:\nThe response includes \\`paginationInfo\\` with:\n- \\`count\\`: Total number of items across all pages\n- \\`pagenum\\`: Current page number\n- \\`pagesize\\`: Items per page (default: 25)\n\n**Check for more pages if ANY of these are true:**\n1. The number of portals returned equals \\`pagesize\\` (e.g., exactly 25 portals returned)\n2. \\`paginationInfo.count > (pagenum * pagesize)\\` - there are more items beyond this page\n3. The response includes a \\`link\\` array with a \\`next\\` relation\n\n### Required pagination workflow:\n1. Start with \\`$pagenum=1\\` and \\`$pagesize=25\\` (default)\n2. After receiving the response, check \\`paginationInfo\\`\n3. **If more pages exist** (using the checks above), automatically call this endpoint again with \\`$pagenum=2\\`, then \\`$pagenum=3\\`, etc.\n4. Continue incrementing \\`$pagenum\\` until:\n   - A page returns fewer portals than \\`pagesize\\` (indicating the last page)\n   - A page returns zero portals\n   - \\`pagenum * pagesize >= paginationInfo.count\\` (if count represents total items)\n5. Merge all portals from all pages by unique portal ID\n6. Only then search through the complete merged list or report results to the user\n\n### Example scenario:\nIf you search for \"business portal\" and the first page returns 25 portals but none match:\n- DO NOT immediately tell the user the portal doesn't exist\n- Check \\`paginationInfo.count\\` - if it's > 25, automatically fetch page 2\n- Continue fetching until all pages are retrieved\n- Search the complete merged list before concluding the portal doesn't exist\n\nThis ensures reliable portal name-to-ID resolution and prevents false \"not found\" errors.\n"
+      "description": "Get All Portals Accessible To User\n\nGet All Portals Accessible to User\n\n## How to Use This Tool\n\n**Parameter Format**: This tool requires a \\`request\\` parameter containing the request object.\n- **CRITICAL**: All parameters in this tool are optional. You may pass an empty request object: \\`{\"request\": {}}\\`\n- If you want to specify a language, pass: \\`{\"request\": {\"Dollar_lang\": \"en-US\"}}\\`\n- The \\`Dollar_lang\\` parameter is **optional** - if omitted, the API defaults to \"en-US\"\n- **Example with empty request** (recommended if you don't need to specify language): \\`{\"request\": {}}\\`\n- **Example with language**: \\`{\"request\": {\"Dollar_lang\": \"en-US\"}}\\`\n\n## Overview\nThe Get All Portals Accessible to User API allows a user to fetch all portals accessible to the user across all departments.\n- If no access tags are specified for a portal, any user can access the portal.\n- If access tags are specified for a portal, users with a user profile that allows access can access the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile.\n- Global users (partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.\n- The only articles returned are associated to an Article type when the parameter “Include in browse on portals” is set to \"Yes\".\n- When the \\`shortUrlTemplate\\` query parameter is provided, the API filters accessible portals according to the specified language and template name. A portal short URL specific to the \\`shortUrlTemplate\\` value is returned in the response when available. If there is no short URL for a language, the portal object returns an empty \\`shortURL\\` field.\n\n## Pagination behavior (CRITICAL for AI assistants)\n\n**IMPORTANT**: This endpoint is paginated. When searching for a portal by name or listing portals, you MUST automatically fetch ALL pages before concluding that a portal doesn't exist.\n\n### Automatic pagination is REQUIRED when:\n- User asks to find a portal by name (e.g., \"business portal\", \"Master portal\")\n- User requests to list or see all portals\n- You need to resolve a natural portal name to its ID\n\n### How to detect more pages exist:\nThe response includes \\`paginationInfo\\` with:\n- \\`count\\`: Total number of items across all pages\n- \\`pagenum\\`: Current page number\n- \\`pagesize\\`: Items per page (default: 25)\n\n**Check for more pages if ANY of these are true:**\n1. The number of portals returned equals \\`pagesize\\` (e.g., exactly 25 portals returned)\n2. \\`paginationInfo.count > (pagenum * pagesize)\\` - there are more items beyond this page\n3. The response includes a \\`link\\` array with a \\`next\\` relation\n\n### Required pagination workflow:\n1. Start with \\`$pagenum=1\\` and \\`$pagesize=25\\` (default)\n2. After receiving the response, check \\`paginationInfo\\`\n3. **If more pages exist** (using the checks above), automatically call this endpoint again with \\`$pagenum=2\\`, then \\`$pagenum=3\\`, etc.\n4. Continue incrementing \\`$pagenum\\` until:\n   - A page returns fewer portals than \\`pagesize\\` (indicating the last page)\n   - A page returns zero portals\n   - \\`pagenum * pagesize >= paginationInfo.count\\` (if count represents total items)\n5. Merge all portals from all pages by unique portal ID\n6. Only then search through the complete merged list or report results to the user\n\n### Example scenario:\nIf you search for \"business portal\" and the first page returns 25 portals but none match:\n- DO NOT immediately tell the user the portal doesn't exist\n- Check \\`paginationInfo.count\\` - if it's > 25, automatically fetch page 2\n- Continue fetching until all pages are retrieved\n- Search the complete merged list before concluding the portal doesn't exist\n\nThis ensures reliable portal name-to-ID resolution and prevents false \"not found\" errors.\n\n## Displaying Results (MCP-Specific)\n**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.\n\n**What to display:**\n- Display all portals with their names and IDs\n- Show portal \\`id\\` (the portal ID needed for other API calls)\n- Display portal \\`name\\` (the human-readable portal name)\n- Show \\`departmentName\\` if available\n- Include \\`shortURL\\` if available\n- Display \\`paginationInfo\\` to show total count and current page\n- Format portals in a clear list format (e.g., \"Portal Name (ID: PORTAL-123)\")\n\n**Example**: \"Here are the available portals: 1) Business Portal (ID: PORTAL-123), 2) Customer Portal (ID: PORTAL-456)...\"\n\n**Important**: Always display portal IDs clearly, as users will need these IDs to call other tools.\n"
     },
     {
       "name": "query-search",
-      "description": "Hybrid Search\n\nThe 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.**\n"
+      "description": "Hybrid Search\n\nHybrid Search\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a \\`request\\` parameter containing the request object. All parameters must be passed inside a \\`request\\` object.\n\n**Parameter Format**: \n- Always wrap parameters in a \\`request\\` object: \\`{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\"}}\\`\n- Required parameters:\n  - \\`portalID\\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - \\`q\\` (string) - The search query string (must be URL-escaped)\n- Optional parameters:\n  - \\`Dollar_lang\\` (string, default: \"en-US\") - Language code\n  - \\`dollarFilterUserProfileID\\` (string) - User profile ID filter\n  - \\`dollarFilterTags\\` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs\n  - \\`dollarFilterTopicIds\\` (array) - Array of topic IDs to filter by\n  - \\`articleCustomAdditionalAttributes\\` (string) - Comma-separated custom attribute names\n  - \\`Dollar_pagenum\\` (number, default: 1) - Page number for pagination\n  - \\`Dollar_pagesize\\` (number, default: 20) - Number of results per page\n\n**Example**: To search for \"loan information\" in portal \"PZ-9999\", call with:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\"}}\n\\`\\`\\`\n\n**Example with optional parameters**:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\", \"Dollar_pagesize\": 25}}\n\\`\\`\\`\n\n**Note**: This endpoint is only available for Self Service environments.\n\n## Displaying Results (MCP-Specific)\n**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.\n\n**What to display:**\n- Display all search results with article names and IDs\n- Show article \\`snippet\\` or \\`keywordSnippet\\` (the relevant text excerpt)\n- Display \\`normalizedScore\\` or \\`relevanceScore\\` to indicate relevance\n- Show \\`docType\\`, \\`source\\`, and \\`topicBreadcrumb\\` metadata\n- Display \\`contextualSummary\\` if available\n- Include \\`paginationInfo\\` if pagination is used\n- Format results in a numbered list with clear relevance indicators\n\n**Example**: \"I found 10 articles matching 'loan information': 1) [Article Name] (ID: PROD-123) - [snippet] (Relevance: 0.89)...\"\n\n## Overview\nThe 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.\n"
     },
     {
       "name": "make-suggestion",
-      "description": "Make a Suggestion\n\nMake a Suggestion\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Make a Suggestion API allows users to create an Article Suggestion from within a knowledge portal. This enables users to submit feedback, request new articles, or suggest improvements to existing content.\n\nUsers can submit suggestions with details about what they're looking for, which helps content creators understand user needs and improve the knowledge base.\n"
+      "description": "Make a Suggestion\n\nMake a Suggestion\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a \\`request\\` parameter containing the request object. All parameters must be passed inside a \\`request\\` object.\n\n**Parameter Format**: \n- Always wrap parameters in a \\`request\\` object: \\`{\"request\": {\"portalID\": \"PZ-9999\", \"CreateSuggestion\": {...}}}\\`\n- Required parameters:\n  - \\`portalID\\` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - \\`CreateSuggestion\\` (object) - The suggestion object with:\n    - \\`name\\` (string, **required**) - Name/title of the suggestion\n    - \\`content\\` (string, **required**) - Content/description of the suggestion\n    - \\`language\\` (object, **required**) - Language object with \\`code\\` property (e.g., {\"code\": \"en-US\"})\n- Optional parameters:\n  - \\`acceptLanguage\\` (string, default: \"en-US\") - Accept-Language header value\n  - \\`CreateSuggestion\\` additional optional fields:\n    - \\`description\\` (string) - Additional description\n    - \\`feedbackArticle\\` (object) - Article ID object if providing feedback on existing article: \\`{\"id\": \"PROD-2996\"}\\`\n    - \\`attachments\\` (object) - Attachments object\n    - \\`customAttributes\\` (array) - Custom attributes array\n\n**Example**: To create a suggestion in portal \"PZ-9999\", call with:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"CreateSuggestion\": {\"name\": \"New Article Request\", \"content\": \"Please add information about loan rates\", \"language\": {\"code\": \"en-US\"}}}}\n\\`\\`\\`\n\n**Example with feedback on existing article**:\n\\`\\`\\`json\n{\"request\": {\"portalID\": \"PZ-9999\", \"CreateSuggestion\": {\"name\": \"Article Feedback\", \"content\": \"This article needs updating\", \"language\": {\"code\": \"en-US\"}, \"feedbackArticle\": {\"id\": \"PROD-2996\"}}}}\n\\`\\`\\`\n\n## Displaying Results (MCP-Specific)\n**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.\n\n**What to display:**\n- Confirm that the suggestion was successfully created\n- Display the suggestion \\`id\\` if returned in the response\n- Show the suggestion \\`name\\` and \\`content\\` that was submitted\n- If an error occurs, display the error message clearly\n- Provide confirmation message to the user\n\n**Example**: \"Your suggestion '[Suggestion Name]' has been successfully submitted. Suggestion ID: [id]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Make a Suggestion API allows users to create an Article Suggestion from within a knowledge portal. This enables users to submit feedback, request new articles, or suggest improvements to existing content.\n\nUsers can submit suggestions with details about what they're looking for, which helps content creators understand user needs and improve the knowledge base.\n"
     }
   ],
   "prompts": [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@egain/egain-mcp-server",
-  "version": "1.0.26",
+  "version": "1.0.27",
   "author": "Emily Loh - eGain Corporation",
   "type": "module",
   "sideEffects": false,

package/src/funcs/getAnnouncements.ts

@@ -34,9 +34,47 @@ import { Result } from "../types/fp.js";
  * @remarks
  * 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.

package/src/funcs/getArticle.ts

@@ -34,6 +34,48 @@ import { Result } from "../types/fp.js";
  * @remarks
  * 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")

package/src/funcs/getPopularArticles.ts

@@ -34,6 +34,43 @@ import { Result } from "../types/fp.js";
  * @remarks
  * 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")

package/src/funcs/getPortals.ts

@@ -34,6 +34,15 @@ import { Result } from "../types/fp.js";
  * @remarks
  * 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.
@@ -81,10 +90,26 @@ import { Result } from "../types/fp.js";
  * - 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.
  */
 export function getPortals(
   client$: EgainMcpCore,
-  request: GetMyPortalsRequest,
+  request?: GetMyPortalsRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -107,7 +132,7 @@ export function getPortals(
 
 async function $do(
   client$: EgainMcpCore,
-  request: GetMyPortalsRequest,
+  request?: GetMyPortalsRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
@@ -126,7 +151,7 @@ async function $do(
 > {
   const parsed$ = safeParse(
     request,
-    (value$) => GetMyPortalsRequest$zodSchema.parse(value$),
+    (value$) => GetMyPortalsRequest$zodSchema.optional().parse(value$),
     "Input validation failed",
   );
   if (!parsed$.ok) {
@@ -136,21 +161,21 @@ async function $do(
   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,
+      payload$?.acceptLanguage,
       { explode: false, charEncoding: "none" },
     ),
   }));

package/src/funcs/makeSuggestion.ts

@@ -34,6 +34,48 @@ import { Result } from "../types/fp.js";
  * @remarks
  * 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")

package/src/funcs/queryAnswers.ts

@@ -34,18 +34,54 @@ import { Result } from "../types/fp.js";
  * @remarks
  * 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.
  */
 export function queryAnswers(
   client$: EgainMcpCore,

package/src/funcs/queryRetrieve.ts

@@ -34,9 +34,49 @@ import { Result } from "../types/fp.js";
  * @remarks
  * 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.

package/src/funcs/querySearch.ts

@@ -32,7 +32,54 @@ import { Result } from "../types/fp.js";
  * Hybrid Search
  *
  * @remarks
- * 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.
  */
 export function querySearch(
   client$: EgainMcpCore,

package/src/lib/config.ts

@@ -82,8 +82,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const 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",
+    "speakeasy-sdk/mcp-typescript 1.0.25 2.723.8 1.0.0 @egain/egain-mcp-server",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "1.0.24",
+    currentVersion: "1.0.25",
   },
 });
 

package/src/mcp-server/server.ts

@@ -34,7 +34,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "EgainMcp",
-    version: "1.0.24",
+    version: "1.0.25",
   });
 
   const getClient = deps.getSDK || (() =>