@egain/egain-mcp-server 1.0.26 → 1.1.0

package/esm/src/funcs/getBestAnswer.js

@@ -0,0 +1,148 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { encodeFormQuery, encodeJSON, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { AnswersResponse$zodSchema, } from "../models/answersresponse.js";
+import { GetBestAnswerRequest$zodSchema, } from "../models/getbestanswerop.js";
+import { APIPromise } from "../types/async.js";
+/**
+ * Generate an Answer
+ *
+ * @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., "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.
+ */
+export function getBestAnswer(client$, request, options) {
+    return new APIPromise($do(client$, request, options));
+}
+async function $do(client$, request, options) {
+    const parsed$ = safeParse(request, (value$) => GetBestAnswerRequest$zodSchema.parse(value$), "Input validation failed");
+    if (!parsed$.ok) {
+        return [parsed$, { status: "invalid" }];
+    }
+    const payload$ = parsed$.value;
+    const body$ = encodeJSON("body", payload$.AnswersRequest, { explode: true });
+    const pathParams$ = {
+        portalID: encodeSimple("portalID", payload$.portalID, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+    const path$ = pathToFunc("/{portalID}/answers")(pathParams$);
+    const query$ = encodeFormQuery({
+        "$filter[tags]": payload$.dollarFilterTags,
+        "$filter[topicIds]": payload$.dollarFilterTopicIds,
+        "$filter[userProfileID]": payload$.dollarFilterUserProfileID,
+        "$lang": payload$.Dollar_lang,
+        "q": payload$.q,
+    });
+    const headers$ = new Headers(compactMap({
+        "Content-Type": "application/json",
+        Accept: "application/json",
+    }));
+    const securityInput = await extractSecurity(client$._options.security);
+    const requestSecurity = resolveGlobalSecurity(securityInput);
+    const context = {
+        options: client$._options,
+        baseURL: options?.serverURL ?? client$._baseURL ?? "",
+        operationID: "getBestAnswer",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: client$._options.security,
+        retryConfig: options?.retries
+            || client$._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || [
+            "429",
+            "500",
+            "502",
+            "503",
+            "504",
+        ],
+    };
+    const requestRes = client$._createRequest(context, {
+        security: requestSecurity,
+        method: "POST",
+        baseURL: options?.serverURL,
+        path: path$,
+        headers: headers$,
+        query: query$,
+        body: body$,
+        userAgent: client$._options.userAgent,
+        timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+            || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req$ = requestRes.value;
+    const doResult = await client$._do(req$, {
+        context,
+        errorCodes: [],
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req$ }];
+    }
+    const response = doResult.value;
+    const responseFields$ = {
+        HttpMeta: { Response: response, Request: req$ },
+    };
+    const [result$] = await M.match(M.json(200, AnswersResponse$zodSchema, { key: "AnswersResponse" }), M.nil(400, AnswersResponse$zodSchema), M.nil(500, AnswersResponse$zodSchema))(response, req$, { extraFields: responseFields$ });
+    return [result$, { status: "complete", request: req$, response }];
+}
+//# sourceMappingURL=getBestAnswer.js.map

package/esm/src/funcs/getBestAnswer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBestAnswer.js","sourceRoot":"","sources":["../../../src/funcs/getBestAnswer.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAChF,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAEL,yBAAyB,GAC1B,MAAM,8BAA8B,CAAC;AAUtC,OAAO,EAEL,8BAA8B,GAC/B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,MAAM,UAAU,aAAa,CAC3B,OAAqB,EACrB,OAA6B,EAC7B,OAAwB;IAaxB,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,OAAO,EACP,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,OAAqB,EACrB,OAA6B,EAC7B,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,8BAA8B,CAAC,KAAK,CAAC,MAAM,CAAC,EACxD,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE7E,MAAM,WAAW,GAAG;QAClB,QAAQ,EAAE,YAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE;YACpD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,KAAK,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAC7C,WAAW,CACZ,CAAC;IACF,MAAM,MAAM,GAAG,eAAe,CAAC;QAC7B,eAAe,EAAE,QAAQ,CAAC,gBAAgB;QAC1C,mBAAmB,EAAE,QAAQ,CAAC,oBAAoB;QAClD,wBAAwB,EAAE,QAAQ,CAAC,yBAAyB;QAC5D,OAAO,EAAE,QAAQ,CAAC,WAAW;QAC7B,GAAG,EAAE,QAAQ,CAAC,CAAC;KAChB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACtC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IACJ,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE;QACrD,WAAW,EAAE,eAAe;QAC5B,YAAY,EAAE,IAAI;QAClB,gBAAgB,EAAE,eAAe;QACjC,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,OAAO,CAAC,QAAQ,CAAC,WAAW;eAC5B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI;YACjC,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;KACF,CAAC;IAEF,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;QACjD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS;QACrC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS;eACtD,CAAC,CAAC;KACR,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;IAE9B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvC,OAAO;QACP,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAChC,MAAM,eAAe,GAAG;QACtB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;KAChD,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAU7B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,yBAAyB,EAAE,EAAE,GAAG,EAAE,iBAAiB,EAAE,CAAC,EAClE,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,yBAAyB,CAAC,EACrC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,yBAAyB,CAAC,CACtC,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AACpE,CAAC"}

package/esm/src/funcs/getMyPortals.d.ts

@@ -0,0 +1,97 @@
+import { EgainMcpCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { APIError } from "../models/errors/apierror.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { GetMyPortalsRequest, GetMyPortalsResponse } from "../models/getmyportalsop.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Get All Portals Accessible To User
+ *
+ * @remarks
+ * Get All Portals Accessible to User
+ *
+ * ## Overview
+ * Retrieves the list of portals available to the authenticated user or application. Each portal contains a readable portal ID that is required by almost all other Portal Manager APIs.
+ *
+ * - If no access tags are specified for a portal, any user can access the portal.
+ * - 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.
+ * - Global users (partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.
+ * - The only articles returned are associated to an Article type when the parameter “Include in browse on portals” is set to "Yes".
+ * - 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.
+ *
+ * ## Prerequisites
+ * Authentication is required. No portal ID is needed for this call. This is typically the first API you should call before using any other tool.
+ *
+ * ## How to Use This Tool
+ * - Call this endpoint to discover which portals you have access to. Use the returned portal IDs as inputs to Retrieve, Answers, Search, Article, and Suggestion APIs.
+ *
+ * ## Parameter Requirements
+ * This tool requires **both** a query language parameter **and** an HTTP language header. An empty request object is **invalid** and MUST NOT be used.
+ *
+ * ### Required (both MUST be provided)
+ * - `Dollar_lang` (string, default: "en-US") - Language code
+ * - `Accept-Language` (string, default: "en-US") - Accept-Language header value
+ *
+ * Both parameters **MUST** be present on every invocation.
+ * If either parameter is missing, the request is invalid.
+ *
+ * #### Optional
+ *
+ * - `Dollar_pagenum` — Page number to retrieve (defaults to `1` if omitted)
+ * - `Dollar_pagesize` — Number of items per page (server default applied if omitted)
+ *
+ * **Example**: To get all portals accessible to the user, call with:
+ * ```json
+ * {"request": {"Dollar_lang": "en-US", "Accept-Language": "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.
+ *
+ * ## Pagination behavior (CRITICAL for AI assistants)
+ *
+ * **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.
+ *
+ * ### Automatic pagination is REQUIRED when:
+ * - User asks to find a portal by name (e.g., "business portal", "Master portal")
+ * - User requests to list or see all portals
+ * - You need to resolve a natural portal name to its ID
+ *
+ * ### How to detect more pages exist:
+ * The response includes `paginationInfo` with:
+ * - `count`: Total number of items across all pages
+ * - `pagenum`: Current page number
+ * - `pagesize`: Items per page (default: 25)
+ *
+ * **Check for more pages if ANY of these are true:**
+ * 1. The number of portals returned equals `pagesize` (e.g., exactly 25 portals returned)
+ * 2. `paginationInfo.count > (pagenum * pagesize)` - there are more items beyond this page
+ * 3. The response includes a `link` array with a `next` relation
+ *
+ * ### Required pagination workflow:
+ * 1. Start with `$pagenum=1` and `$pagesize=25` (default)
+ * 2. After receiving the response, check `paginationInfo`
+ * 3. **If more pages exist** (using the checks above), automatically call this endpoint again with `$pagenum=2`, then `$pagenum=3`, etc.
+ * 4. Continue incrementing `$pagenum` until:
+ *    - A page returns fewer portals than `pagesize` (indicating the last page)
+ *    - A page returns zero portals
+ *    - `pagenum * pagesize >= paginationInfo.count` (if count represents total items)
+ * 5. Merge all portals from all pages by unique portal ID
+ * 6. Only then search through the complete merged list or report results to the user
+ *
+ * ### Example scenario:
+ * If you search for "business portal" and the first page returns 25 portals but none match:
+ * - DO NOT immediately tell the user the portal doesn't exist
+ * - Check `paginationInfo.count` - if it's > 25, automatically fetch page 2
+ * - Continue fetching until all pages are retrieved
+ * - 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)
+ * Always display the list of portals returned. Show portal name, portal ID, and any descriptive metadata. If multiple portals exist, prompt the user to select one for subsequent calls.
+ */
+export declare function getMyPortals(client$: EgainMcpCore, request: GetMyPortalsRequest, options?: RequestOptions): APIPromise<Result<GetMyPortalsResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+//# sourceMappingURL=getMyPortals.d.ts.map

package/esm/src/funcs/getMyPortals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getMyPortals.d.ts","sourceRoot":"","sources":["../../../src/funcs/getMyPortals.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,mBAAmB,EAEnB,oBAAoB,EAErB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,oBAAoB,EAClB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}

package/esm/src/funcs/getMyPortals.js

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GetMyPortalsRequest$zodSchema, GetMyPortalsResponse$zodSchema, } from "../models/getmyportalsop.js";
+import { APIPromise } from "../types/async.js";
+/**
+ * Get All Portals Accessible To User
+ *
+ * @remarks
+ * Get All Portals Accessible to User
+ *
+ * ## Overview
+ * Retrieves the list of portals available to the authenticated user or application. Each portal contains a readable portal ID that is required by almost all other Portal Manager APIs.
+ *
+ * - If no access tags are specified for a portal, any user can access the portal.
+ * - 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.
+ * - Global users (partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.
+ * - The only articles returned are associated to an Article type when the parameter “Include in browse on portals” is set to "Yes".
+ * - 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.
+ *
+ * ## Prerequisites
+ * Authentication is required. No portal ID is needed for this call. This is typically the first API you should call before using any other tool.
+ *
+ * ## How to Use This Tool
+ * - Call this endpoint to discover which portals you have access to. Use the returned portal IDs as inputs to Retrieve, Answers, Search, Article, and Suggestion APIs.
+ *
+ * ## Parameter Requirements
+ * This tool requires **both** a query language parameter **and** an HTTP language header. An empty request object is **invalid** and MUST NOT be used.
+ *
+ * ### Required (both MUST be provided)
+ * - `Dollar_lang` (string, default: "en-US") - Language code
+ * - `Accept-Language` (string, default: "en-US") - Accept-Language header value
+ *
+ * Both parameters **MUST** be present on every invocation.
+ * If either parameter is missing, the request is invalid.
+ *
+ * #### Optional
+ *
+ * - `Dollar_pagenum` — Page number to retrieve (defaults to `1` if omitted)
+ * - `Dollar_pagesize` — Number of items per page (server default applied if omitted)
+ *
+ * **Example**: To get all portals accessible to the user, call with:
+ * ```json
+ * {"request": {"Dollar_lang": "en-US", "Accept-Language": "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.
+ *
+ * ## Pagination behavior (CRITICAL for AI assistants)
+ *
+ * **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.
+ *
+ * ### Automatic pagination is REQUIRED when:
+ * - User asks to find a portal by name (e.g., "business portal", "Master portal")
+ * - User requests to list or see all portals
+ * - You need to resolve a natural portal name to its ID
+ *
+ * ### How to detect more pages exist:
+ * The response includes `paginationInfo` with:
+ * - `count`: Total number of items across all pages
+ * - `pagenum`: Current page number
+ * - `pagesize`: Items per page (default: 25)
+ *
+ * **Check for more pages if ANY of these are true:**
+ * 1. The number of portals returned equals `pagesize` (e.g., exactly 25 portals returned)
+ * 2. `paginationInfo.count > (pagenum * pagesize)` - there are more items beyond this page
+ * 3. The response includes a `link` array with a `next` relation
+ *
+ * ### Required pagination workflow:
+ * 1. Start with `$pagenum=1` and `$pagesize=25` (default)
+ * 2. After receiving the response, check `paginationInfo`
+ * 3. **If more pages exist** (using the checks above), automatically call this endpoint again with `$pagenum=2`, then `$pagenum=3`, etc.
+ * 4. Continue incrementing `$pagenum` until:
+ *    - A page returns fewer portals than `pagesize` (indicating the last page)
+ *    - A page returns zero portals
+ *    - `pagenum * pagesize >= paginationInfo.count` (if count represents total items)
+ * 5. Merge all portals from all pages by unique portal ID
+ * 6. Only then search through the complete merged list or report results to the user
+ *
+ * ### Example scenario:
+ * If you search for "business portal" and the first page returns 25 portals but none match:
+ * - DO NOT immediately tell the user the portal doesn't exist
+ * - Check `paginationInfo.count` - if it's > 25, automatically fetch page 2
+ * - Continue fetching until all pages are retrieved
+ * - 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)
+ * Always display the list of portals returned. Show portal name, portal ID, and any descriptive metadata. If multiple portals exist, prompt the user to select one for subsequent calls.
+ */
+export function getMyPortals(client$, request, options) {
+    return new APIPromise($do(client$, request, options));
+}
+async function $do(client$, request, options) {
+    const parsed$ = safeParse(request, (value$) => GetMyPortalsRequest$zodSchema.parse(value$), "Input validation failed");
+    if (!parsed$.ok) {
+        return [parsed$, { status: "invalid" }];
+    }
+    const payload$ = parsed$.value;
+    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,
+    });
+    const headers$ = new Headers(compactMap({
+        Accept: "application/json",
+        "Accept-Language": encodeSimple("Accept-Language", payload$.acceptLanguage, { explode: false, charEncoding: "none" }),
+    }));
+    const securityInput = await extractSecurity(client$._options.security);
+    const requestSecurity = resolveGlobalSecurity(securityInput);
+    const context = {
+        options: client$._options,
+        baseURL: options?.serverURL ?? client$._baseURL ?? "",
+        operationID: "getMyPortals",
+        oAuth2Scopes: null,
+        resolvedSecurity: requestSecurity,
+        securitySource: client$._options.security,
+        retryConfig: options?.retries
+            || client$._options.retryConfig
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || [
+            "429",
+            "500",
+            "502",
+            "503",
+            "504",
+        ],
+    };
+    const requestRes = client$._createRequest(context, {
+        security: requestSecurity,
+        method: "GET",
+        baseURL: options?.serverURL,
+        path: path$,
+        headers: headers$,
+        query: query$,
+        body: body$,
+        userAgent: client$._options.userAgent,
+        timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+            || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req$ = requestRes.value;
+    const doResult = await client$._do(req$, {
+        context,
+        errorCodes: [],
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req$ }];
+    }
+    const response = doResult.value;
+    const responseFields$ = {
+        HttpMeta: { Response: response, Request: req$ },
+    };
+    const [result$] = await M.match(M.json(200, GetMyPortalsResponse$zodSchema, {
+        key: "AllAccessiblePortals",
+    }), M.nil(204, GetMyPortalsResponse$zodSchema), M.json([400, 401, 403, 404, 406], GetMyPortalsResponse$zodSchema, {
+        key: "WSErrorCommon",
+    }), M.json(500, GetMyPortalsResponse$zodSchema, { key: "WSErrorCommon" }))(response, req$, { extraFields: responseFields$ });
+    return [result$, { status: "complete", request: req$, response }];
+}
+//# sourceMappingURL=getMyPortals.js.map

package/esm/src/funcs/getMyPortals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getMyPortals.js","sourceRoot":"","sources":["../../../src/funcs/getMyPortals.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAU3C,OAAO,EAEL,6BAA6B,EAE7B,8BAA8B,GAC/B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsFG;AACH,MAAM,UAAU,YAAY,CAC1B,OAAqB,EACrB,OAA4B,EAC5B,OAAwB;IAaxB,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,OAAO,EACP,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,OAAqB,EACrB,OAA4B,EAC5B,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,6BAA6B,CAAC,KAAK,CAAC,MAAM,CAAC,EACvD,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC;IACnB,MAAM,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;IACzC,MAAM,MAAM,GAAG,eAAe,CAAC;QAC7B,OAAO,EAAE,QAAQ,CAAC,WAAW;QAC7B,QAAQ,EAAE,QAAQ,CAAC,YAAY;QAC/B,UAAU,EAAE,QAAQ,CAAC,cAAc;QACnC,WAAW,EAAE,QAAQ,CAAC,eAAe;QACrC,OAAO,EAAE,QAAQ,CAAC,WAAW;QAC7B,YAAY,EAAE,QAAQ,CAAC,UAAU;QACjC,YAAY,EAAE,QAAQ,CAAC,UAAU;QACjC,kBAAkB,EAAE,QAAQ,CAAC,gBAAgB;KAC9C,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,EAAE,kBAAkB;QAC1B,iBAAiB,EAAE,YAAY,CAC7B,iBAAiB,EACjB,QAAQ,CAAC,cAAc,EACvB,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;KACF,CAAC,CAAC,CAAC;IACJ,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE;QACrD,WAAW,EAAE,cAAc;QAC3B,YAAY,EAAE,IAAI;QAClB,gBAAgB,EAAE,eAAe;QACjC,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,OAAO,CAAC,QAAQ,CAAC,WAAW;eAC5B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI;YACjC,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;KACF,CAAC;IAEF,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;QACjD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS;QACrC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS;eACtD,CAAC,CAAC;KACR,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;IAE9B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvC,OAAO;QACP,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAChC,MAAM,eAAe,GAAG;QACtB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;KAChD,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAU7B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,8BAA8B,EAAE;QAC1C,GAAG,EAAE,sBAAsB;KAC5B,CAAC,EACF,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,8BAA8B,CAAC,EAC1C,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,8BAA8B,EAAE;QAChE,GAAG,EAAE,eAAe;KACrB,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,8BAA8B,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CACtE,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AACpE,CAAC"}

package/esm/src/funcs/getPopularArticles.d.ts

@@ -12,6 +12,45 @@ 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")
+ *   - `acceptLanguage` (string, default: "en-US") - Accept-Language header value
+ * - 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/esm/src/funcs/getPopularArticles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getPopularArticles.d.ts","sourceRoot":"","sources":["../../../src/funcs/getPopularArticles.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,yBAAyB,EAEzB,0BAA0B,EAE3B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,0BAA0B,EACxB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}
+{"version":3,"file":"getPopularArticles.d.ts","sourceRoot":"","sources":["../../../src/funcs/getPopularArticles.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,yBAAyB,EAEzB,0BAA0B,EAE3B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,0BAA0B,EACxB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}

package/esm/src/funcs/getPopularArticles.js

@@ -1,7 +1,7 @@
 /*
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
-import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import { encodeFormQuery, encodeSimple, queryJoin } from "../lib/encodings.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { safeParse } from "../lib/schemas.js";
@@ -15,6 +15,45 @@ import { APIPromise } from "../types/async.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")
+ *   - `acceptLanguage` (string, default: "en-US") - Accept-Language header value
+ * - 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")
@@ -41,16 +80,21 @@ async function $do(client$, request, options) {
         }),
     };
     const path$ = pathToFunc("/portals/{portalID}/populararticles")(pathParams$);
-    const query$ = encodeFormQuery({
+    const query$ = queryJoin(encodeFormQuery({
+        "articleResultAdditionalAttributes": payload$.articleResultAdditionalAttributes,
+    }, { explode: false }), encodeFormQuery({
         "$filter[tags]": payload$.dollarFilterTags,
         "$filter[topicId]": payload$.dollarFilterTopicId,
         "$lang": payload$.Dollar_lang,
         "$pagenum": payload$.Dollar_pagenum,
         "$pagesize": payload$.Dollar_pagesize,
-    });
+    }));
     const headers$ = new Headers(compactMap({
         Accept: "application/json",
         "Accept-Language": encodeSimple("Accept-Language", payload$.acceptLanguage, { explode: false, charEncoding: "none" }),
+        "x-egain-activity-id": encodeSimple("x-egain-activity-id", payload$.xEgainActivityId, { explode: false, charEncoding: "none" }),
+        "x-ext-integration-id": encodeSimple("x-ext-integration-id", payload$.xExtIntegrationId, { explode: false, charEncoding: "none" }),
+        "x-ext-interaction-id": encodeSimple("x-ext-interaction-id", payload$.xExtInteractionId, { explode: false, charEncoding: "none" }),
     }));
     const securityInput = await extractSecurity(client$._options.security);
     const requestSecurity = resolveGlobalSecurity(securityInput);

package/esm/src/funcs/getPopularArticles.js.map

@@ -1 +1 @@
-{"version":3,"file":"getPopularArticles.js","sourceRoot":"","sources":["../../../src/funcs/getPopularArticles.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAU3C,OAAO,EAEL,mCAAmC,EAEnC,oCAAoC,GACrC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAqB,EACrB,OAAkC,EAClC,OAAwB;IAaxB,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,OAAO,EACP,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,OAAqB,EACrB,OAAkC,EAClC,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,mCAAmC,CAAC,KAAK,CAAC,MAAM,CAAC,EAC7D,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC;IAEnB,MAAM,WAAW,GAAG;QAClB,QAAQ,EAAE,YAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE;YACpD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,KAAK,GAAG,UAAU,CAAC,qCAAqC,CAAC,CAC7D,WAAW,CACZ,CAAC;IACF,MAAM,MAAM,GAAG,eAAe,CAAC;QAC7B,eAAe,EAAE,QAAQ,CAAC,gBAAgB;QAC1C,kBAAkB,EAAE,QAAQ,CAAC,mBAAmB;QAChD,OAAO,EAAE,QAAQ,CAAC,WAAW;QAC7B,UAAU,EAAE,QAAQ,CAAC,cAAc;QACnC,WAAW,EAAE,QAAQ,CAAC,eAAe;KACtC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,EAAE,kBAAkB;QAC1B,iBAAiB,EAAE,YAAY,CAC7B,iBAAiB,EACjB,QAAQ,CAAC,cAAc,EACvB,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;KACF,CAAC,CAAC,CAAC;IACJ,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE;QACrD,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,IAAI;QAClB,gBAAgB,EAAE,eAAe;QACjC,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,OAAO,CAAC,QAAQ,CAAC,WAAW;eAC5B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI;YACjC,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;KACF,CAAC;IAEF,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;QACjD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS;QACrC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS;eACtD,CAAC,CAAC;KACR,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;IAE9B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvC,OAAO;QACP,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAChC,MAAM,eAAe,GAAG;QACtB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;KAChD,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAU7B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,oCAAoC,EAAE;QAChD,GAAG,EAAE,gBAAgB;KACtB,CAAC,EACF,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,oCAAoC,CAAC,EAChD,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,oCAAoC,EAAE;QACtE,GAAG,EAAE,eAAe;KACrB,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,oCAAoC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAC5E,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AACpE,CAAC"}
+{"version":3,"file":"getPopularArticles.js","sourceRoot":"","sources":["../../../src/funcs/getPopularArticles.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,KAAK,CAAC,MAAM,oBAAoB,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAU3C,OAAO,EAEL,mCAAmC,EAEnC,oCAAoC,GACrC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAqB,EACrB,OAAkC,EAClC,OAAwB;IAaxB,OAAO,IAAI,UAAU,CAAC,GAAG,CACvB,OAAO,EACP,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,OAAqB,EACrB,OAAkC,EAClC,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,mCAAmC,CAAC,KAAK,CAAC,MAAM,CAAC,EAC7D,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC1C,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC;IAEnB,MAAM,WAAW,GAAG;QAClB,QAAQ,EAAE,YAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,QAAQ,EAAE;YACpD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,KAAK,GAAG,UAAU,CAAC,qCAAqC,CAAC,CAC7D,WAAW,CACZ,CAAC;IACF,MAAM,MAAM,GAAG,SAAS,CACtB,eAAe,CAAC;QACd,mCAAmC,EACjC,QAAQ,CAAC,iCAAiC;KAC7C,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EACtB,eAAe,CAAC;QACd,eAAe,EAAE,QAAQ,CAAC,gBAAgB;QAC1C,kBAAkB,EAAE,QAAQ,CAAC,mBAAmB;QAChD,OAAO,EAAE,QAAQ,CAAC,WAAW;QAC7B,UAAU,EAAE,QAAQ,CAAC,cAAc;QACnC,WAAW,EAAE,QAAQ,CAAC,eAAe;KACtC,CAAC,CACH,CAAC;IAEF,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACtC,MAAM,EAAE,kBAAkB;QAC1B,iBAAiB,EAAE,YAAY,CAC7B,iBAAiB,EACjB,QAAQ,CAAC,cAAc,EACvB,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;QACD,qBAAqB,EAAE,YAAY,CACjC,qBAAqB,EACrB,QAAQ,CAAC,gBAAgB,EACzB,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;QACD,sBAAsB,EAAE,YAAY,CAClC,sBAAsB,EACtB,QAAQ,CAAC,iBAAiB,EAC1B,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;QACD,sBAAsB,EAAE,YAAY,CAClC,sBAAsB,EACtB,QAAQ,CAAC,iBAAiB,EAC1B,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,CACzC;KACF,CAAC,CAAC,CAAC;IACJ,MAAM,aAAa,GAAG,MAAM,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvE,MAAM,eAAe,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,IAAI,EAAE;QACrD,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,IAAI;QAClB,gBAAgB,EAAE,eAAe;QACjC,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;QACzC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,OAAO,CAAC,QAAQ,CAAC,WAAW;eAC5B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI;YACjC,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;SACN;KACF,CAAC;IAEF,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;QACjD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,MAAM;QACb,IAAI,EAAE,KAAK;QACX,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS;QACrC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS;eACtD,CAAC,CAAC;KACR,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC;IAE9B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE;QACvC,OAAO;QACP,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAChC,MAAM,eAAe,GAAG;QACtB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE;KAChD,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAU7B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,oCAAoC,EAAE;QAChD,GAAG,EAAE,gBAAgB;KACtB,CAAC,EACF,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,oCAAoC,CAAC,EAChD,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,oCAAoC,EAAE;QACtE,GAAG,EAAE,eAAe;KACrB,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,oCAAoC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAC5E,CAAC,QAAQ,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAEpD,OAAO,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;AACpE,CAAC"}

package/esm/src/funcs/getPortals.d.ts

@@ -12,6 +12,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.
@@ -59,6 +68,22 @@ 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 declare function getPortals(client$: EgainMcpCore, request: GetMyPortalsRequest, options?: RequestOptions): APIPromise<Result<GetMyPortalsResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+export declare function getPortals(client$: EgainMcpCore, request?: GetMyPortalsRequest | undefined, options?: RequestOptions): APIPromise<Result<GetMyPortalsResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
 //# sourceMappingURL=getPortals.d.ts.map