@egain/egain-mcp-server 1.0.26 → 1.1.0

package/esm/src/cloudflare-worker/cloudflare-worker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cloudflare-worker.d.ts","sourceRoot":"","sources":["../../../src/cloudflare-worker/cloudflare-worker.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,UAAU,KAAK;CAAG;AAElB,KAAK,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEpC,qBAAa,wBAAyB,SAAQ,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC;IACvE,MAAM,EAAG,SAAS,CAAC;IAEb,IAAI;IAOV,MAAM;CAeP;;mBAGsB,OAAO,OAAO,GAAG,OAAO,GAAG;;AADlD,wBAsDE"}
+{"version":3,"file":"cloudflare-worker.d.ts","sourceRoot":"","sources":["../../../src/cloudflare-worker/cloudflare-worker.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,UAAU,KAAK;CAAG;AAElB,KAAK,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEpC,qBAAa,wBAAyB,SAAQ,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC;IACvE,MAAM,EAAG,SAAS,CAAC;IAEb,IAAI;IASV,MAAM;CAkBP;;mBAGsB,OAAO,OAAO,GAAG,OAAO,GAAG;;AADlD,wBA8DE"}

package/esm/src/cloudflare-worker/cloudflare-worker.js

@@ -3,28 +3,32 @@
  */
 import { McpAgent } from "agents/mcp";
 import { EgainMcpCore } from "../core.js";
+import { landingPage } from "../landing-page.js";
 import { createConsoleLogger } from "../mcp-server/console-logger.js";
 import { createMCPServer } from "../mcp-server/server.js";
-import { landingPage } from "./landing-page.js";
 export class AtEgainEgainMcpServerMCP extends McpAgent {
     server;
     async init() {
-        this.server = createMCPServer({
+        const { server } = createMCPServer({
             logger: createConsoleLogger("debug"),
             getSDK: () => this.getSDK(),
         });
+        this.server = server;
     }
     getSDK() {
-        const getHeader = (name) => this.props[name] || "";
+        const getHeader = (name) => this.props?.[name] ?? "";
         const sdk = new EgainMcpCore({
             debugLogger: {
                 log: (...args) => console.log(...args),
                 group: (...args) => console.group(...args),
                 groupEnd: (...args) => console.groupEnd(...args),
             },
-            security: async () => {
-                return { accessToken: getHeader("authorization") };
-            },
+            security: async () => ({
+                oAuthUser: getHeader("Authorization"),
+                oAuthCustomer: getHeader("Authorization"),
+                oAuthAnonymousCustomer: getHeader("Authorization"),
+                accessToken: getHeader("authorization"),
+            }),
         });
         return sdk;
     }
@@ -40,18 +44,25 @@ export default {
         ctx.props = headers;
         if (url.pathname === "/sse" || url.pathname.startsWith("/sse/")) {
             return AtEgainEgainMcpServerMCP.serveSSE("/sse", {
-                binding: "@EGAIN/EGAIN-MCP-SERVER_MCP",
+                binding: "EGAIN_EGAIN_MCP_SERVER_MCP",
             }).fetch(request, env, ctx);
         }
         if (url.pathname === "/mcp") {
             return AtEgainEgainMcpServerMCP.serve("/mcp", {
-                binding: "@EGAIN/EGAIN-MCP-SERVER_MCP",
+                binding: "EGAIN_EGAIN_MCP_SERVER_MCP",
             }).fetch(request, env, ctx);
         }
         // Landing page
         if (url.pathname === "/") {
             return landingPage(request);
         }
+        // NOTE: we renamed .dxt extension to .mcpb; redirect for backwards compatibility
+        if (url.pathname.endsWith(".dxt")) {
+            const newPath = url.pathname.replace(/\.dxt$/, ".mcpb");
+            const newUrl = new URL(url);
+            newUrl.pathname = newPath;
+            return Response.redirect(newUrl.toString(), 301);
+        }
         // Fallback to serving static assets
         const response = await env.ASSETS.fetch(request);
         // Only modify headers if asset was found successfully
@@ -60,7 +71,7 @@ export default {
             return new Response(response.body, {
                 headers: {
                     "Content-Type": "application/octet-stream",
-                    "Content-Disposition": "attachment; filename=\"mcp-server.dxt\"",
+                    "Content-Disposition": "attachment; filename=\"mcp-server.mcpb\"",
                     "Cache-Control": "public, max-age=3600",
                 },
             });

package/esm/src/cloudflare-worker/cloudflare-worker.js.map

@@ -1 +1 @@
-{"version":3,"file":"cloudflare-worker.js","sourceRoot":"","sources":["../../../src/cloudflare-worker/cloudflare-worker.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAMhD,MAAM,OAAO,wBAAyB,SAAQ,QAA2B;IACvE,MAAM,CAAa;IAEnB,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,MAAM,GAAG,eAAe,CAAC;YAC5B,MAAM,EAAE,mBAAmB,CAAC,OAAO,CAAC;YACpC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED,MAAM;QACJ,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAE3D,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC;YAC3B,WAAW,EAAE;gBACX,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;gBACtC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;gBAC1C,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;aACjD;YACD,QAAQ,EAAE,KAAK,IAAI,EAAE;gBACnB,OAAO,EAAE,WAAW,EAAE,SAAS,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,CAAC;SACF,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAED,eAAe;IACb,KAAK,CAAC,KAAK,CAAC,OAAgB,EAAE,GAAQ,EAAE,GAAQ;QAC9C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEjC,6CAA6C;QAC7C,MAAM,OAAO,GAA2B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACrD,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;QACrC,CAAC;QACD,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC;QAEpB,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAChE,OAAO,wBAAwB,CAAC,QAAQ,CAAC,MAAM,EAAE;gBAC/C,OAAO,EAAE,6BAA6B;aACvC,CAAC,CAAC,KAAK,CACN,OAAO,EACP,GAAG,EACH,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC5B,OAAO,wBAAwB,CAAC,KAAK,CAAC,MAAM,EAAE;gBAC5C,OAAO,EAAE,6BAA6B;aACvC,CAAC,CAAC,KAAK,CACN,OAAO,EACP,GAAG,EACH,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,eAAe;QACf,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;QAED,oCAAoC;QACpC,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEjD,sDAAsD;QACtD,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YAChB,uCAAuC;YACvC,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE;gBACjC,OAAO,EAAE;oBACP,cAAc,EAAE,0BAA0B;oBAC1C,qBAAqB,EAAE,yCAAyC;oBAChE,eAAe,EAAE,sBAAsB;iBACxC;aACF,CAAC,CAAC;QACL,CAAC;QAED,sDAAsD;QACtD,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF,CAAC"}
+{"version":3,"file":"cloudflare-worker.js","sourceRoot":"","sources":["../../../src/cloudflare-worker/cloudflare-worker.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAM1D,MAAM,OAAO,wBAAyB,SAAQ,QAA2B;IACvE,MAAM,CAAa;IAEnB,KAAK,CAAC,IAAI;QACR,MAAM,EAAE,MAAM,EAAE,GAAG,eAAe,CAAC;YACjC,MAAM,EAAE,mBAAmB,CAAC,OAAO,CAAC;YACpC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE;SAC5B,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM;QACJ,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAE7D,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC;YAC3B,WAAW,EAAE;gBACX,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;gBACtC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;gBAC1C,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;aACjD;YACD,QAAQ,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;gBACrB,SAAS,EAAE,SAAS,CAAC,eAAe,CAAC;gBACrC,aAAa,EAAE,SAAS,CAAC,eAAe,CAAC;gBACzC,sBAAsB,EAAE,SAAS,CAAC,eAAe,CAAC;gBAClD,WAAW,EAAE,SAAS,CAAC,eAAe,CAAC;aACxC,CAAC;SACH,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAED,eAAe;IACb,KAAK,CAAC,KAAK,CAAC,OAAgB,EAAE,GAAQ,EAAE,GAAQ;QAC9C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAEjC,6CAA6C;QAC7C,MAAM,OAAO,GAA2B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACrD,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,KAAK,CAAC;QACrC,CAAC;QACD,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC;QAEpB,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAChE,OAAO,wBAAwB,CAAC,QAAQ,CAAC,MAAM,EAAE;gBAC/C,OAAO,EAAE,4BAA4B;aACtC,CAAC,CAAC,KAAK,CACN,OAAO,EACP,GAAG,EACH,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,IAAI,GAAG,CAAC,QAAQ,KAAK,MAAM,EAAE,CAAC;YAC5B,OAAO,wBAAwB,CAAC,KAAK,CAAC,MAAM,EAAE;gBAC5C,OAAO,EAAE,4BAA4B;aACtC,CAAC,CAAC,KAAK,CACN,OAAO,EACP,GAAG,EACH,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,eAAe;QACf,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;YACzB,OAAO,WAAW,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;QAED,iFAAiF;QACjF,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACxD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC;YAC1B,OAAO,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;QACnD,CAAC;QAED,oCAAoC;QACpC,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEjD,sDAAsD;QACtD,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YAChB,uCAAuC;YACvC,OAAO,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE;gBACjC,OAAO,EAAE;oBACP,cAAc,EAAE,0BAA0B;oBAC1C,qBAAqB,EAAE,0CAA0C;oBACjE,eAAe,EAAE,sBAAsB;iBACxC;aACF,CAAC,CAAC;QACL,CAAC;QAED,sDAAsD;QACtD,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF,CAAC"}

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

@@ -0,0 +1,63 @@
+import { EgainMcpCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { AiSearchRequest, AiSearchResponseResponse } from "../models/aisearchop.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 { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Hybrid Search
+ *
+ * @remarks
+ * 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 declare function aiSearch(client$: EgainMcpCore, request: AiSearchRequest, options?: RequestOptions): APIPromise<Result<AiSearchResponseResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+//# sourceMappingURL=aiSearch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aiSearch.d.ts","sourceRoot":"","sources":["../../../src/funcs/aiSearch.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACL,eAAe,EAEf,wBAAwB,EAEzB,MAAM,yBAAyB,CAAC;AACjC,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,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,wBAAgB,QAAQ,CACtB,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,wBAAwB,EACtB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}

package/esm/src/funcs/aiSearch.js

@@ -0,0 +1,151 @@
+/*
+ * 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 { AiSearchRequest$zodSchema, AiSearchResponseResponse$zodSchema, } from "../models/aisearchop.js";
+import { APIPromise } from "../types/async.js";
+/**
+ * Hybrid Search
+ *
+ * @remarks
+ * 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 aiSearch(client$, request, options) {
+    return new APIPromise($do(client$, request, options));
+}
+async function $do(client$, request, options) {
+    const parsed$ = safeParse(request, (value$) => AiSearchRequest$zodSchema.parse(value$), "Input validation failed");
+    if (!parsed$.ok) {
+        return [parsed$, { status: "invalid" }];
+    }
+    const payload$ = parsed$.value;
+    const body$ = null;
+    const pathParams$ = {
+        portalID: encodeSimple("portalID", payload$.portalID, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+    const path$ = pathToFunc("/{portalID}/search")(pathParams$);
+    const query$ = encodeFormQuery({
+        "$filter[tags]": payload$.dollarFilterTags,
+        "$filter[topicIds]": payload$.dollarFilterTopicIds,
+        "$filter[userProfileID]": payload$.dollarFilterUserProfileID,
+        "$lang": payload$.Dollar_lang,
+        "$pagenum": payload$.Dollar_pagenum,
+        "$pagesize": payload$.Dollar_pagesize,
+        "articleCustomAdditionalAttributes": payload$.articleCustomAdditionalAttributes,
+        "q": payload$.q,
+    });
+    const headers$ = new Headers(compactMap({
+        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: "aiSearch",
+        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, AiSearchResponseResponse$zodSchema, {
+        key: "AISearchResponse",
+    }), M.nil(204, AiSearchResponseResponse$zodSchema), M.json([400, 401, 403, 404, 406], AiSearchResponseResponse$zodSchema, {
+        key: "WSErrorCommon",
+    }), M.json(500, AiSearchResponseResponse$zodSchema, { key: "WSErrorCommon" }))(response, req$, { extraFields: responseFields$ });
+    return [result$, { status: "complete", request: req$, response }];
+}
+//# sourceMappingURL=aiSearch.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"aiSearch.js","sourceRoot":"","sources":["../../../src/funcs/aiSearch.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;AAC3C,OAAO,EAEL,yBAAyB,EAEzB,kCAAkC,GACnC,MAAM,yBAAyB,CAAC;AAUjC,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,UAAU,QAAQ,CACtB,OAAqB,EACrB,OAAwB,EACxB,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,OAAwB,EACxB,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,yBAAyB,CAAC,KAAK,CAAC,MAAM,CAAC,EACnD,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,oBAAoB,CAAC,CAC5C,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,UAAU,EAAE,QAAQ,CAAC,cAAc;QACnC,WAAW,EAAE,QAAQ,CAAC,eAAe;QACrC,mCAAmC,EACjC,QAAQ,CAAC,iCAAiC;QAC5C,GAAG,EAAE,QAAQ,CAAC,CAAC;KAChB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;QACtC,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,UAAU;QACvB,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,kCAAkC,EAAE;QAC9C,GAAG,EAAE,kBAAkB;KACxB,CAAC,EACF,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,kCAAkC,CAAC,EAC9C,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,kCAAkC,EAAE;QACpE,GAAG,EAAE,eAAe;KACrB,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,kCAAkC,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAC1E,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/getAnnouncementArticles.d.ts

@@ -0,0 +1,61 @@
+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 { GetAnnouncementArticlesRequest, GetAnnouncementArticlesResponse } from "../models/getannouncementarticlesop.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Get Announcement Articles
+ *
+ * @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")
+ *   - `acceptLanguage` (string, default: "en-US") - Accept-Language header value
+ * - Optional parameters:
+ *   - `Dollar_lang` (string, default: "en-US") - Language code
+ *   - `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., "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.
+ *
+ * This API returns announcement articles with their full content, metadata, and any associated attachments or links.
+ */
+export declare function getAnnouncementArticles(client$: EgainMcpCore, request: GetAnnouncementArticlesRequest, options?: RequestOptions): APIPromise<Result<GetAnnouncementArticlesResponse, APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+//# sourceMappingURL=getAnnouncementArticles.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getAnnouncementArticles.d.ts","sourceRoot":"","sources":["../../../src/funcs/getAnnouncementArticles.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,8BAA8B,EAE9B,+BAA+B,EAEhC,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,8BAA8B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,+BAA+B,EAC7B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}

package/esm/src/funcs/getAnnouncementArticles.js

@@ -0,0 +1,152 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+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";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GetAnnouncementArticlesRequest$zodSchema, GetAnnouncementArticlesResponse$zodSchema, } from "../models/getannouncementarticlesop.js";
+import { APIPromise } from "../types/async.js";
+/**
+ * Get Announcement Articles
+ *
+ * @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")
+ *   - `acceptLanguage` (string, default: "en-US") - Accept-Language header value
+ * - Optional parameters:
+ *   - `Dollar_lang` (string, default: "en-US") - Language code
+ *   - `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., "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.
+ *
+ * This API returns announcement articles with their full content, metadata, and any associated attachments or links.
+ */
+export function getAnnouncementArticles(client$, request, options) {
+    return new APIPromise($do(client$, request, options));
+}
+async function $do(client$, request, options) {
+    const parsed$ = safeParse(request, (value$) => GetAnnouncementArticlesRequest$zodSchema.parse(value$), "Input validation failed");
+    if (!parsed$.ok) {
+        return [parsed$, { status: "invalid" }];
+    }
+    const payload$ = parsed$.value;
+    const body$ = null;
+    const pathParams$ = {
+        portalID: encodeSimple("portalID", payload$.portalID, {
+            explode: false,
+            charEncoding: "percent",
+        }),
+    };
+    const path$ = pathToFunc("/portals/{portalID}/articles/announcements")(pathParams$);
+    const query$ = queryJoin(encodeFormQuery({
+        "articleResultAdditionalAttributes": payload$.articleResultAdditionalAttributes,
+    }, { explode: false }), encodeFormQuery({
+        "$filter[tags]": payload$.dollarFilterTags,
+        "$lang": payload$.Dollar_lang,
+        "$pagenum": payload$.Dollar_pagenum,
+        "$pagesize": payload$.Dollar_pagesize,
+        "workflowMilestone": payload$.workflowMilestone,
+    }));
+    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);
+    const context = {
+        options: client$._options,
+        baseURL: options?.serverURL ?? client$._baseURL ?? "",
+        operationID: "getAnnouncementArticles",
+        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, GetAnnouncementArticlesResponse$zodSchema, {
+        key: "ArticleResults",
+    }), M.nil(204, GetAnnouncementArticlesResponse$zodSchema), M.json([400, 401, 403, 404, 406], GetAnnouncementArticlesResponse$zodSchema, { key: "WSErrorCommon" }), M.json(500, GetAnnouncementArticlesResponse$zodSchema, {
+        key: "WSErrorCommon",
+    }))(response, req$, { extraFields: responseFields$ });
+    return [result$, { status: "complete", request: req$, response }];
+}
+//# sourceMappingURL=getAnnouncementArticles.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getAnnouncementArticles.js","sourceRoot":"","sources":["../../../src/funcs/getAnnouncementArticles.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,wCAAwC,EAExC,yCAAyC,GAC1C,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAqB,EACrB,OAAuC,EACvC,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,OAAuC,EACvC,OAAwB;IAgBxB,MAAM,OAAO,GAAG,SAAS,CACvB,OAAO,EACP,CAAC,MAAM,EAAE,EAAE,CAAC,wCAAwC,CAAC,KAAK,CAAC,MAAM,CAAC,EAClE,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,4CAA4C,CAAC,CACpE,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,OAAO,EAAE,QAAQ,CAAC,WAAW;QAC7B,UAAU,EAAE,QAAQ,CAAC,cAAc;QACnC,WAAW,EAAE,QAAQ,CAAC,eAAe;QACrC,mBAAmB,EAAE,QAAQ,CAAC,iBAAiB;KAChD,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,yBAAyB;QACtC,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,yCAAyC,EAAE;QACrD,GAAG,EAAE,gBAAgB;KACtB,CAAC,EACF,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,yCAAyC,CAAC,EACrD,CAAC,CAAC,IAAI,CACJ,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EACzB,yCAAyC,EACzC,EAAE,GAAG,EAAE,eAAe,EAAE,CACzB,EACD,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,yCAAyC,EAAE;QACrD,GAAG,EAAE,eAAe;KACrB,CAAC,CACH,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/getAnnouncements.d.ts

@@ -12,9 +12,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/esm/src/funcs/getAnnouncements.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getAnnouncements.d.ts","sourceRoot":"","sources":["../../../src/funcs/getAnnouncements.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,8BAA8B,EAE9B,+BAA+B,EAEhC,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,8BAA8B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,+BAA+B,EAC7B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}
+{"version":3,"file":"getAnnouncements.d.ts","sourceRoot":"","sources":["../../../src/funcs/getAnnouncements.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,8BAA8B,EAE9B,+BAA+B,EAEhC,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,8BAA8B,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,+BAA+B,EAC7B,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAMA"}