@egain/egain-mcp-server 1.0.26 → 1.1.0

package/src/models/retrieveresponse.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 import {
   ReferenceResponse,
   ReferenceResponse$zodSchema,
@@ -12,14 +13,20 @@ import { SearchResult, SearchResult$zodSchema } from "./searchresult.js";
 /**
  * Specifies that the answer produced was a certified answer.
  */
+export const RetrieveResponseAnswerType = {
+  Certified: "certified",
+} as const;
+/**
+ * Specifies that the answer produced was a certified answer.
+ */
+export type RetrieveResponseAnswerType = ClosedEnum<
+  typeof RetrieveResponseAnswerType
+>;
+
 export const RetrieveResponseAnswerType$zodSchema = z.enum([
   "certified",
 ]).describe("Specifies that the answer produced was a certified answer.");
 
-export type RetrieveResponseAnswerType = z.infer<
-  typeof RetrieveResponseAnswerType$zodSchema
->;
-
 /**
  * If a certified answer is given. The answer object will be present. <br><br> This will be shown only if certified answers are configured and the certified answer meets the configured threshold.
  */
@@ -27,18 +34,16 @@ export type RetrieveResponseAnswer = {
   answerValue: string;
   references: Array<ReferenceResponse>;
   answerType: RetrieveResponseAnswerType;
-  relevanceScore?: number | undefined;
+  relevanceScore: number;
 };
 
 export const RetrieveResponseAnswer$zodSchema: z.ZodType<
-  RetrieveResponseAnswer,
-  z.ZodTypeDef,
-  unknown
+  RetrieveResponseAnswer
 > = z.object({
   answerType: RetrieveResponseAnswerType$zodSchema,
   answerValue: z.string(),
   references: z.array(ReferenceResponse$zodSchema),
-  relevanceScore: z.number().optional(),
+  relevanceScore: z.number(),
 }).describe(
   "If a certified answer is given. The answer object will be present. <br><br> This will be shown only if certified answers are configured and the certified answer meets the configured threshold.",
 );
@@ -46,6 +51,15 @@ export const RetrieveResponseAnswer$zodSchema: z.ZodType<
 /**
  * The channel where the query originated, e.g., directly from the portal or via a custom integration.
  */
+export const RetrieveResponseType = {
+  Portal: "portal",
+  Custom: "custom",
+} as const;
+/**
+ * The channel where the query originated, e.g., directly from the portal or via a custom integration.
+ */
+export type RetrieveResponseType = ClosedEnum<typeof RetrieveResponseType>;
+
 export const RetrieveResponseType$zodSchema = z.enum([
   "portal",
   "custom",
@@ -53,19 +67,13 @@ export const RetrieveResponseType$zodSchema = z.enum([
   "The channel where the query originated, e.g., directly from the portal or via a custom integration.",
 );
 
-export type RetrieveResponseType = z.infer<
-  typeof RetrieveResponseType$zodSchema
->;
-
 export type RetrieveResponseChannel = {
   type: RetrieveResponseType;
   name?: string | undefined;
 };
 
 export const RetrieveResponseChannel$zodSchema: z.ZodType<
-  RetrieveResponseChannel,
-  z.ZodTypeDef,
-  unknown
+  RetrieveResponseChannel
 > = z.object({
   name: z.string().optional(),
   type: RetrieveResponseType$zodSchema,
@@ -80,15 +88,13 @@ export type RetrieveResponse = {
   sessionId: string;
 };
 
-export const RetrieveResponse$zodSchema: z.ZodType<
-  RetrieveResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  answer: z.lazy(() => RetrieveResponseAnswer$zodSchema).optional(),
-  channel: z.lazy(() => RetrieveResponseChannel$zodSchema).optional(),
-  clientSessionId: z.string().optional(),
-  eventId: z.string().optional(),
-  searchResults: z.array(SearchResult$zodSchema),
-  sessionId: z.string(),
-});
+export const RetrieveResponse$zodSchema: z.ZodType<RetrieveResponse> = z.object(
+  {
+    answer: z.lazy(() => RetrieveResponseAnswer$zodSchema).optional(),
+    channel: z.lazy(() => RetrieveResponseChannel$zodSchema).optional(),
+    clientSessionId: z.string().optional(),
+    eventId: z.string().optional(),
+    searchResults: z.array(SearchResult$zodSchema),
+    sessionId: z.string(),
+  },
+);

package/src/models/schemaslink.ts

@@ -10,11 +10,7 @@ export type SchemasLink = {
   _default?: boolean | undefined;
 };
 
-export const SchemasLink$zodSchema: z.ZodType<
-  SchemasLink,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const SchemasLink$zodSchema: z.ZodType<SchemasLink> = z.object({
   _default: z.boolean().optional(),
   href: z.string().optional(),
   rel: z.string().optional(),

package/src/models/schemastags.ts

@@ -9,11 +9,7 @@ export type SchemasTags = {
   tags?: Array<string> | undefined;
 };
 
-export const SchemasTags$zodSchema: z.ZodType<
-  SchemasTags,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const SchemasTags$zodSchema: z.ZodType<SchemasTags> = z.object({
   id: z.string().optional(),
   tags: z.array(z.string()).optional(),
 });

package/src/models/searchresult.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
 import {
   AITopicBreadcrumb,
   AITopicBreadcrumb$zodSchema,
@@ -11,6 +12,17 @@ import {
 /**
  * Format of the source document (HTML, DOCX, PPTX, or PDF).
  */
+export const SearchResultDocType = {
+  Html: "HTML",
+  Docx: "DOCX",
+  Pdf: "PDF",
+  Pptx: "PPTX",
+} as const;
+/**
+ * Format of the source document (HTML, DOCX, PPTX, or PDF).
+ */
+export type SearchResultDocType = ClosedEnum<typeof SearchResultDocType>;
+
 export const SearchResultDocType$zodSchema = z.enum([
   "HTML",
   "DOCX",
@@ -18,11 +30,18 @@ export const SearchResultDocType$zodSchema = z.enum([
   "PPTX",
 ]).describe("Format of the source document (HTML, DOCX, PPTX, or PDF).");
 
-export type SearchResultDocType = z.infer<typeof SearchResultDocType$zodSchema>;
-
 /**
  * The repository or system where the content originated (e.g., eGain Article, eGain Attachment).
  */
+export const SearchResultSource = {
+  EGainArticle: "eGain Article",
+  EGainAttachment: "eGain Attachment",
+} as const;
+/**
+ * The repository or system where the content originated (e.g., eGain Article, eGain Attachment).
+ */
+export type SearchResultSource = ClosedEnum<typeof SearchResultSource>;
+
 export const SearchResultSource$zodSchema = z.enum([
   "eGain Article",
   "eGain Attachment",
@@ -30,7 +49,16 @@ export const SearchResultSource$zodSchema = z.enum([
   "The repository or system where the content originated (e.g., eGain Article, eGain Attachment).",
 );
 
-export type SearchResultSource = z.infer<typeof SearchResultSource$zodSchema>;
+export const SnippetType = {
+  Chunks: "chunks",
+  ArticleContent: "articleContent",
+} as const;
+export type SnippetType = ClosedEnum<typeof SnippetType>;
+
+export const SnippetType$zodSchema = z.enum([
+  "chunks",
+  "articleContent",
+]);
 
 /**
  * Represents a single document or snippet returned by search, along with its metadata and relevance score.
@@ -43,16 +71,13 @@ export type SearchResult = {
   source: SearchResultSource;
   snippet: string;
   contextualSummary?: string | undefined;
+  snippetType?: SnippetType | undefined;
   relevanceScore?: number | undefined;
   normalizedScore?: number | undefined;
   topicBreadcrumb?: Array<AITopicBreadcrumb> | undefined;
 };
 
-export const SearchResult$zodSchema: z.ZodType<
-  SearchResult,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const SearchResult$zodSchema: z.ZodType<SearchResult> = z.object({
   contextualSummary: z.string().optional(),
   docName: z.string().optional(),
   docType: SearchResultDocType$zodSchema,
@@ -61,6 +86,7 @@ export const SearchResult$zodSchema: z.ZodType<
   normalizedScore: z.number().optional(),
   relevanceScore: z.number().optional(),
   snippet: z.string(),
+  snippetType: SnippetType$zodSchema.optional(),
   source: SearchResultSource$zodSchema,
   topicBreadcrumb: z.array(AITopicBreadcrumb$zodSchema).optional(),
 }).describe(

package/src/models/security.ts

@@ -4,11 +4,18 @@
 
 import * as z from "zod";
 
-export type Security = { accessToken: string };
+export type Security = {
+  oAuthUser?: string | undefined;
+  oAuthCustomer?: string | undefined;
+  oAuthAnonymousCustomer?: string | undefined;
+  accessToken?: string | undefined;
+};
 
-export const Security$zodSchema: z.ZodType<Security, z.ZodTypeDef, unknown> = z
-  .object({
-    accessToken: z.string().describe(
-      "JWT Bearer Token authentication for API access",
-    ),
-  });
+export const Security$zodSchema: z.ZodType<Security> = z.object({
+  accessToken: z.string().describe(
+    "JWT Bearer Token authentication for API access",
+  ).optional(),
+  oAuthAnonymousCustomer: z.string().describe("API Key").optional(),
+  oAuthCustomer: z.string().describe("API Key").optional(),
+  oAuthUser: z.string().describe("API Key").optional(),
+});

package/src/models/shorturl.ts

@@ -11,10 +11,9 @@ export type ShortURL = {
   isDefault?: boolean | undefined;
 };
 
-export const ShortURL$zodSchema: z.ZodType<ShortURL, z.ZodTypeDef, unknown> = z
-  .object({
-    id: z.string().optional(),
-    isDefault: z.boolean().optional(),
-    shortURLName: z.string().optional(),
-    templateName: z.string().optional(),
-  });
+export const ShortURL$zodSchema: z.ZodType<ShortURL> = z.object({
+  id: z.string().optional(),
+  isDefault: z.boolean().optional(),
+  shortURLName: z.string().optional(),
+  templateName: z.string().optional(),
+});

package/src/models/sortidnamedepartment.ts

@@ -3,13 +3,17 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+export const SortIdNameDepartment = {
+  Id: "id",
+  Name: "name",
+  DepartmentName: "departmentName",
+} as const;
+export type SortIdNameDepartment = ClosedEnum<typeof SortIdNameDepartment>;
 
 export const SortIdNameDepartment$zodSchema = z.enum([
   "id",
   "name",
   "departmentName",
 ]);
-
-export type SortIdNameDepartment = z.infer<
-  typeof SortIdNameDepartment$zodSchema
->;

package/src/models/stage.ts

@@ -13,8 +13,7 @@ export type Stage = {
   milestone?: Milestone | undefined;
 };
 
-export const Stage$zodSchema: z.ZodType<Stage, z.ZodTypeDef, unknown> = z
-  .object({
-    milestone: Milestone$zodSchema.optional(),
-    name: z.string().optional(),
-  }).describe("A stage in the Article's workflow.");
+export const Stage$zodSchema: z.ZodType<Stage> = z.object({
+  milestone: Milestone$zodSchema.optional(),
+  name: z.string().optional(),
+}).describe("A stage in the Article's workflow.");

package/src/models/structuredauthoringfields.ts

@@ -13,9 +13,7 @@ export type StructuredAuthoringFields = {
 };
 
 export const StructuredAuthoringFields$zodSchema: z.ZodType<
-  StructuredAuthoringFields,
-  z.ZodTypeDef,
-  unknown
+  StructuredAuthoringFields
 > = z.object({
   cause: z.string().optional(),
   confidenceLevel: L10NString$zodSchema.optional(),

package/src/models/tag.ts

@@ -6,7 +6,7 @@ import * as z from "zod";
 
 export type Tag = { name?: string | undefined; id?: string | undefined };
 
-export const Tag$zodSchema: z.ZodType<Tag, z.ZodTypeDef, unknown> = z.object({
+export const Tag$zodSchema: z.ZodType<Tag> = z.object({
   id: z.string().optional(),
   name: z.string().optional(),
 });

package/src/models/tagcategory.ts

@@ -16,11 +16,7 @@ export type TagCategory = {
   tagGroups?: TagGroups | undefined;
 };
 
-export const TagCategory$zodSchema: z.ZodType<
-  TagCategory,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const TagCategory$zodSchema: z.ZodType<TagCategory> = z.object({
   id: z.string().optional(),
   name: z.string().optional(),
   tagGroups: TagGroups$zodSchema.optional(),

package/src/models/taggroup.ts

@@ -6,8 +6,7 @@ import * as z from "zod";
 
 export type TagGroup = { name?: string | undefined; id?: string | undefined };
 
-export const TagGroup$zodSchema: z.ZodType<TagGroup, z.ZodTypeDef, unknown> = z
-  .object({
-    id: z.string().optional(),
-    name: z.string().optional(),
-  });
+export const TagGroup$zodSchema: z.ZodType<TagGroup> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+});

package/src/models/taggroups.ts

@@ -7,7 +7,6 @@ import { TagGroup, TagGroup$zodSchema } from "./taggroup.js";
 
 export type TagGroups = { tagGroup?: Array<TagGroup> | undefined };
 
-export const TagGroups$zodSchema: z.ZodType<TagGroups, z.ZodTypeDef, unknown> =
-  z.object({
-    tagGroup: z.array(TagGroup$zodSchema).optional(),
-  });
+export const TagGroups$zodSchema: z.ZodType<TagGroups> = z.object({
+  tagGroup: z.array(TagGroup$zodSchema).optional(),
+});

package/src/models/tags.ts

@@ -7,6 +7,6 @@ import { Tag, Tag$zodSchema } from "./tag.js";
 
 export type Tags = { tag?: Array<Tag> | undefined };
 
-export const Tags$zodSchema: z.ZodType<Tags, z.ZodTypeDef, unknown> = z.object({
+export const Tags$zodSchema: z.ZodType<Tags> = z.object({
   tag: z.array(Tag$zodSchema).optional(),
 });

package/src/models/topicbreadcrumb.ts

@@ -12,10 +12,6 @@ export type TopicBreadcrumb = {
   topicSummary?: Array<TopicSummary> | undefined;
 };
 
-export const TopicBreadcrumb$zodSchema: z.ZodType<
-  TopicBreadcrumb,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const TopicBreadcrumb$zodSchema: z.ZodType<TopicBreadcrumb> = z.object({
   topicSummary: z.array(TopicSummary$zodSchema).optional(),
 }).describe("This schema contains one or more TopicSummary instances.");

package/src/models/topicsummary.ts

@@ -14,11 +14,7 @@ export type TopicSummary = {
   link?: Link | undefined;
 };
 
-export const TopicSummary$zodSchema: z.ZodType<
-  TopicSummary,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const TopicSummary$zodSchema: z.ZodType<TopicSummary> = z.object({
   id: z.string().optional(),
   link: Link$zodSchema.optional(),
   name: z.string().optional(),

package/src/models/workflow.ts

@@ -10,7 +10,6 @@ import { Stage, Stage$zodSchema } from "./stage.js";
  */
 export type Workflow = { stages?: Array<Stage> | undefined };
 
-export const Workflow$zodSchema: z.ZodType<Workflow, z.ZodTypeDef, unknown> = z
-  .object({
-    stages: z.array(Stage$zodSchema).optional(),
-  }).describe("The Article's workflow.");
+export const Workflow$zodSchema: z.ZodType<Workflow> = z.object({
+  stages: z.array(Stage$zodSchema).optional(),
+}).describe("The Article's workflow.");

package/src/models/workflowmilestone.ts

@@ -3,11 +3,17 @@
  */
 
 import * as z from "zod";
+import { ClosedEnum } from "../types/enums.js";
+
+export const WorkflowMilestone = {
+  Authoring: "authoring",
+  Staging: "staging",
+  Publish: "publish",
+} as const;
+export type WorkflowMilestone = ClosedEnum<typeof WorkflowMilestone>;
 
 export const WorkflowMilestone$zodSchema = z.enum([
   "authoring",
   "staging",
   "publish",
 ]);
-
-export type WorkflowMilestone = z.infer<typeof WorkflowMilestone$zodSchema>;

package/src/models/wserrorcommon.ts

@@ -6,11 +6,10 @@ import * as z from "zod";
 
 export type Detail = { key: string; value?: string | undefined };
 
-export const Detail$zodSchema: z.ZodType<Detail, z.ZodTypeDef, unknown> = z
-  .object({
-    key: z.string(),
-    value: z.string().optional(),
-  });
+export const Detail$zodSchema: z.ZodType<Detail> = z.object({
+  key: z.string(),
+  value: z.string().optional(),
+});
 
 /**
  * Bad Request
@@ -22,11 +21,7 @@ export type WSErrorCommon = {
   userMessage?: string | undefined;
 };
 
-export const WSErrorCommon$zodSchema: z.ZodType<
-  WSErrorCommon,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
+export const WSErrorCommon$zodSchema: z.ZodType<WSErrorCommon> = z.object({
   code: z.string(),
   details: z.array(z.lazy(() => Detail$zodSchema)).optional(),
   developerMessage: z.string(),

package/src/tool-names.ts

@@ -0,0 +1,35 @@
+// Auto-generated at build time
+export const toolNames: Array<{ name: string; description: string }>= [
+  {
+    "name": "retrieve-chunks",
+    "description": "Retrieve Chunks\n\nRetrieve Chunks\n## Overview\nThe Retrieve API enables enterprises to directly access relevant content chunks from their organizational knowledge sources. It is designed for scenarios where developers want granular control over retrieved information, such as powering custom search, analytics, or retrieval-augmented generation (RAG) pipelines.\nIn addition to raw chunk retrieval, the API can return **Certified Answers** if it meets the 'Certified Answer' threshold score. Responses include relevance scores, metadata, and references to maintain transparency and flexibility.\nBy leveraging the Retrieve API, organizations can build tailored experiences while retaining confidence in the source material.\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-1004\")\n\n## How to Use This Tool\nAll inputs must be wrapped inside a request object. Provide a search query and language. Optional filters can be used to narrow results by tags, topics, or user profile.\n\n**Parameter Format**: \n- Always wrap parameters in a `request` object: `{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\"}}`\n- Required parameters:\n  - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - `q` (string) - The search query string\n  - `Dollar_lang` (string) - Language code (e.g., \"en-US\")\n- Optional parameters:\n  - `dollarFilterUserProfileID` (string) - User profile ID filter\n  - `dollarFilterTags` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs\n  - `dollarFilterTopicIds` (array) - Array of topic IDs to filter by\n  - `RetrieveRequest` (object) - Additional request body parameters:\n    - `channel` (object) - Channel information (optional, recommended to omit)\n    - `eventId` (string) - Event ID\n    - `sessionId` (string) - Session ID\n\n**Example**: To retrieve chunks for query \"loan information\" from portal \"PZ-9999\", call with:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\"}}\n```\n\n**Example with RetrieveRequest body**:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\", \"RetrieveRequest\": {\"eventId\": \"event-123\", \"sessionId\": \"session-456\"}}}\n```\n\n## Displaying Results (MCP-Specific)\n**CRITICAL**: When this tool returns data successfully, you MUST display the results to the user in your response. Do not silently process the data - always show the user what was returned.\n\n**What to display:**\nAlways display results. Show each article name, article ID, snippet, and relevance score. If a certified answer is returned, display it first and list its references.\n\n**Example**: \"I found 5 relevant articles about loan information: 1) [Article Name] (ID: PROD-123) - [snippet]...\"\n"
+  },
+  {
+    "name": "get-best-answer",
+    "description": "Generate an Answer\n\nGet Answers\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a `request` parameter containing the request object. All parameters must be passed inside a `request` object.\n\n**Parameter Format**: \n- Always wrap parameters in a `request` object: `{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\"}}`\n- Required parameters:\n  - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - `q` (string) - The search query string\n  - `Dollar_lang` (string) - Language code (e.g., \"en-US\")\n- Optional parameters:\n  - `dollarFilterUserProfileID` (string) - User profile ID filter\n  - `dollarFilterTags` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs\n  - `dollarFilterTopicIds` (array) - Array of topic IDs to filter by\n  - `AnswersRequest` (object) - Request body parameters:\n    - `eventId` (string, **required**) - Event ID\n    - `sessionId` (string, **required**) - Session ID\n    - `channel` (object, **optional**, recommended to omit) - Channel information. Omit unless specifically needed. If you receive a 400 error with channel, retry without it.\n    - `context` (object) - Additional context (companyContext, pageContext, userContext)\n\n**Example**: To get answers for query \"loan information\" from portal \"PZ-9999\", call with:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\", \"AnswersRequest\": {\"eventId\": \"event-123\", \"sessionId\": \"session-456\"}}}\n```\n\n**Note**: The `channel` field in `AnswersRequest` is optional and recommended to omit unless specifically needed. The API works reliably without it.\n\n## Displaying Results (MCP-Specific)\n**CRITICAL**: When this tool returns data successfully, you MUST display the results to the user in your response. Do not silently process the data - always show the user what was returned.\n\n**What to display:**\n- Display the `answer.answerValue` text prominently as the main answer to the user's query\n- Indicate the answer type (`answerType`: \"certified\" or \"generative\")\n- If `relevanceScore` is present, you may mention the confidence level\n- List all `references` (article IDs and names) that were used to generate the answer\n- Display `searchResults` showing related articles with their names, IDs, snippets, and relevance scores\n- Format the answer in a clear, readable way - this is the primary response the user is seeking\n\n**Example**: \"Based on the knowledge base, here's the answer: [answerValue]. This answer was generated using information from: [list references]. Related articles: [list search results]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-1004\")\n\n## Overview\nThe Answers API enables users to get the best answer for a user query. This API can return certified answers or generative answers along with search results, providing users with comprehensive responses to their questions.\n\nThe API leverages AI capabilities to provide intelligent answers based on the knowledge base content, making it easier for users to find the information they need quickly and accurately.\n"
+  },
+  {
+    "name": "get-article-by-id",
+    "description": "Get Article by ID\n\nGet Article by ID\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a `request` parameter containing the request object. All parameters must be passed inside a `request` object.\n\n**Parameter Format**: \n- Always wrap parameters in a `request` object: `{\"request\": {\"portalID\": \"PZ-9999\", \"articleID\": \"PROD-2996\"}}`\n- Required parameters:\n  - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - `articleID` (string) - The article ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PROD-2996\")\n  - `acceptLanguage` (string, default: \"en-US\") - Accept-Language header value\n- Optional parameters:\n  - `Dollar_lang` (string, default: \"en-US\") - Language code\n  - `articleAdditionalAttributes` (array) - Additional article attributes to return\n  - `Dollar_customAdditionalAttributes` (string) - Custom additional attributes\n  - `accessSource` (string, default: \"article_view\") - How the article was accessed\n  - `publishViewId` (string) - Publish view ID\n  - `workflowMilestone` (string) - Workflow milestone filter\n\n**Example**: To get article \"PROD-2996\" from portal \"PZ-9999\", call with:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"articleID\": \"PROD-2996\"}}\n```\n\n**Example with optional parameters**:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"articleID\": \"PROD-2996\", \"Dollar_lang\": \"en-US\", \"accessSource\": \"article_view\"}}\n```\n\n## Displaying Results (MCP-Specific)\n**CRITICAL**: When this tool returns data successfully, you MUST display the article content to the user in your response. Do not silently process the data - always show the user what was returned.\n\n**What to display:**\n- Display the article `name` as the title\n- Show the article `content` or `contentText` (the full article body)\n- Display article metadata: `id`, `articleType`, `createdDate`, `modifiedDate`\n- Show `attachments` if present\n- Display `topicBreadcrumb` to show where the article is categorized\n- Include any other relevant metadata like `articleSummary`, `description`, `articleKeywords`\n- Format the article content in a readable way for the user\n\n**Example**: \"Here's the article '[Article Name]' (ID: PROD-2996): [article content]. This article is categorized under: [topic breadcrumb]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n- Requires a valid article ID. Article ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-2996\")\n\n## Overview\nThe Get Article by ID API allows a user to retrieve a specific article using its ID. Additional article attributes and contextual views can be specified in the query parameters.\n\nThis API returns structured authoring attributes of Issue, Environment, Cause and Confidence Level when the following conditions are met:\n- The \"Allow Structured Authoring\" setting is enabled at the partition/department level\n- The \"Use Structured Authoring\" flag is set on the article type\n"
+  },
+  {
+    "name": "get-announcement-articles",
+    "description": "Get Announcement Articles\n\nGet Announcements\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a `request` parameter containing the request object. All parameters must be passed inside a `request` object.\n\n**Parameter Format**: \n- Always wrap parameters in a `request` object: `{\"request\": {\"portalID\": \"PZ-9999\"}}`\n- Required parameter:\n  - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - `acceptLanguage` (string, default: \"en-US\") - Accept-Language header value\n- Optional parameters:\n  - `Dollar_lang` (string, default: \"en-US\") - Language code\n  - `Dollar_pagesize` (number, default: 10) - Number of results per page\n\n**Example**: To get announcements from portal \"PZ-9999\", call with:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\"}}\n```\n\n**Example with optional parameters**:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"Dollar_lang\": \"en-US\", \"Dollar_pagesize\": 20}}\n```\n\n## Displaying Results (MCP-Specific)\n**CRITICAL**: When this tool returns data successfully, you MUST display the announcement articles to the user in your response. Do not silently process the data - always show the user what was returned.\n\n**What to display:**\n- Display all announcement articles with their names and IDs\n- Show the article content (`content` or `contentText`) for each announcement\n- Display metadata such as `createdDate`, `modifiedDate`, `articleSummary`\n- Show `attachments` if present\n- Include `paginationInfo` if pagination is used\n- Format announcements in a clear list format\n\n**Example**: \"Here are the announcements for this portal: 1) [Announcement Name] (ID: PROD-123) - [content]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"PROD-1004\")\n\n## Overview\nThe Get Announcements API allows a user to retrieve all announcement articles for a specific portal. Announcements are special articles that are prominently displayed to users and typically contain important updates, news, or notifications.\n\nThis API returns announcement articles with their full content, metadata, and any associated attachments or links.\n"
+  },
+  {
+    "name": "get-popular-articles",
+    "description": "Get Popular Articles\n\nGet Popular Articles\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a `request` parameter containing the request object. All parameters must be passed inside a `request` object.\n\n**Parameter Format**: \n- Always wrap parameters in a `request` object: `{\"request\": {\"portalID\": \"PZ-9999\"}}`\n- Required parameter:\n  - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - `acceptLanguage` (string, default: \"en-US\") - Accept-Language header value\n- Optional parameters:\n  - `Dollar_lang` (string, default: \"en-US\") - Language code\n  - `Dollar_pagenum` (number, default: 1) - Page number for pagination\n  - `Dollar_pagesize` (number, default: 10) - Number of results per page\n  - `dollarFilterTopicId` (string) - Filter by topic ID\n  - `dollarFilterTags` (string) - Comma-separated list of Tag/Tag Group IDs\n\n**Example**: To get popular articles from portal \"PZ-9999\", call with:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\"}}\n```\n\n**Example with optional parameters**:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"Dollar_lang\": \"en-US\", \"Dollar_pagesize\": 20}}\n```\n\n## Displaying Results (MCP-Specific)\n**CRITICAL**: When this tool returns data successfully, you MUST display the popular articles to the user in your response. Do not silently process the data - always show the user what was returned.\n\n**What to display:**\n- Display all popular articles with their names and IDs\n- Show article summaries or descriptions when available\n- Display metadata such as `articleType`, `createdDate`, `modifiedDate`\n- Show `imageURL` if available (mention thumbnail availability)\n- Include `paginationInfo` if pagination is used\n- Format articles in a numbered or bulleted list\n\n**Example**: \"Here are the most popular articles: 1) [Article Name] (ID: PROD-123) - [summary]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Popular Articles API allows a user to retrieve the most popular articles from a specific portal. Popular articles are typically determined by user engagement metrics such as views, ratings, or usage frequency.\n\nThis API returns a list of popular articles with their metadata, allowing users to discover the most relevant and frequently accessed content within the portal.\n"
+  },
+  {
+    "name": "get-my-portals",
+    "description": "Get All Portals Accessible To User\n\nGet All Portals Accessible to User\n\n## Overview\nRetrieves 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.\n\n- If no access tags are specified for a portal, any user can access the portal.\n- If access tags are specified for a portal, users with a user profile that allows access can access the portal. For users with multiple user profiles, the user profile that allows access does not need to be the active user profile.\n- Global users (partition) cannot be assigned user profiles; their access is limited to portals without access restrictions.\n- The only articles returned are associated to an Article type when the parameter “Include in browse on portals” is set to \"Yes\".\n- When the `shortUrlTemplate` query parameter is provided, the API filters accessible portals according to the specified language and template name. A portal short URL specific to the `shortUrlTemplate` value is returned in the response when available. If there is no short URL for a language, the portal object returns an empty `shortURL` field.\n\n## Prerequisites\nAuthentication is required. No portal ID is needed for this call. This is typically the first API you should call before using any other tool.\n\n## How to Use This Tool\n- 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.\n\n## Parameter Requirements\nThis tool requires **both** a query language parameter **and** an HTTP language header. An empty request object is **invalid** and MUST NOT be used.\n\n### Required (both MUST be provided)\n- `Dollar_lang` (string, default: \"en-US\") - Language code\n- `Accept-Language` (string, default: \"en-US\") - Accept-Language header value\n\nBoth parameters **MUST** be present on every invocation.  \nIf either parameter is missing, the request is invalid.\n\n#### Optional\n\n- `Dollar_pagenum` — Page number to retrieve (defaults to `1` if omitted)\n- `Dollar_pagesize` — Number of items per page (server default applied if omitted)\n\n**Example**: To get all portals accessible to the user, call with:\n```json\n{\"request\": {\"Dollar_lang\": \"en-US\", \"Accept-Language\": \"en-US\"}}\n```\n\n## Overview\nThe Get All Portals Accessible to User API allows a user to fetch all portals accessible to the user across all departments.\n\n## Pagination behavior (CRITICAL for AI assistants)\n\n**IMPORTANT**: This endpoint is paginated. When searching for a portal by name or listing portals, you MUST automatically fetch ALL pages before concluding that a portal doesn't exist.\n\n### Automatic pagination is REQUIRED when:\n- User asks to find a portal by name (e.g., \"business portal\", \"Master portal\")\n- User requests to list or see all portals\n- You need to resolve a natural portal name to its ID\n\n### How to detect more pages exist:\nThe response includes `paginationInfo` with:\n- `count`: Total number of items across all pages\n- `pagenum`: Current page number\n- `pagesize`: Items per page (default: 25)\n\n**Check for more pages if ANY of these are true:**\n1. The number of portals returned equals `pagesize` (e.g., exactly 25 portals returned)\n2. `paginationInfo.count > (pagenum * pagesize)` - there are more items beyond this page\n3. The response includes a `link` array with a `next` relation\n\n### Required pagination workflow:\n1. Start with `$pagenum=1` and `$pagesize=25` (default)\n2. After receiving the response, check `paginationInfo`\n3. **If more pages exist** (using the checks above), automatically call this endpoint again with `$pagenum=2`, then `$pagenum=3`, etc.\n4. Continue incrementing `$pagenum` until:\n   - A page returns fewer portals than `pagesize` (indicating the last page)\n   - A page returns zero portals\n   - `pagenum * pagesize >= paginationInfo.count` (if count represents total items)\n5. Merge all portals from all pages by unique portal ID\n6. Only then search through the complete merged list or report results to the user\n\n### Example scenario:\nIf you search for \"business portal\" and the first page returns 25 portals but none match:\n- DO NOT immediately tell the user the portal doesn't exist\n- Check `paginationInfo.count` - if it's > 25, automatically fetch page 2\n- Continue fetching until all pages are retrieved\n- Search the complete merged list before concluding the portal doesn't exist\n\nThis ensures reliable portal name-to-ID resolution and prevents false \"not found\" errors.\n\n## Displaying Results (MCP-Specific)\nAlways 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.\n"
+  },
+  {
+    "name": "ai-search",
+    "description": "Hybrid Search\n\nHybrid Search\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a `request` parameter containing the request object. All parameters must be passed inside a `request` object.\n\n**Parameter Format**: \n- Always wrap parameters in a `request` object: `{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\"}}`\n- Required parameters:\n  - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - `q` (string) - The search query string (must be URL-escaped)\n- Optional parameters:\n  - `Dollar_lang` (string, default: \"en-US\") - Language code\n  - `dollarFilterUserProfileID` (string) - User profile ID filter\n  - `dollarFilterTags` (object) - Object where keys are Category Tag IDs and values are arrays of Tag IDs\n  - `dollarFilterTopicIds` (array) - Array of topic IDs to filter by\n  - `articleCustomAdditionalAttributes` (string) - Comma-separated custom attribute names\n  - `Dollar_pagenum` (number, default: 1) - Page number for pagination\n  - `Dollar_pagesize` (number, default: 20) - Number of results per page\n\n**Example**: To search for \"loan information\" in portal \"PZ-9999\", call with:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\"}}\n```\n\n**Example with optional parameters**:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"q\": \"loan information\", \"Dollar_lang\": \"en-US\", \"Dollar_pagesize\": 25}}\n```\n\n**Note**: This endpoint is only available for Self Service environments.\n\n## Displaying Results (MCP-Specific)\n**CRITICAL**: When this tool returns data successfully, you MUST display the search results to the user in your response. Do not silently process the data - always show the user what was returned.\n\n**What to display:**\n- Display all search results with article names and IDs\n- Show article `snippet` or `keywordSnippet` (the relevant text excerpt)\n- Display `normalizedScore` or `relevanceScore` to indicate relevance\n- Show `docType`, `source`, and `topicBreadcrumb` metadata\n- Display `contextualSummary` if available\n- Include `paginationInfo` if pagination is used\n- Format results in a numbered list with clear relevance indicators\n\n**Example**: \"I found 10 articles matching 'loan information': 1) [Article Name] (ID: PROD-123) - [snippet] (Relevance: 0.89)...\"\n\n## Overview\nThe Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores.\n"
+  },
+  {
+    "name": "make-suggestion",
+    "description": "Make a Suggestion\n\nMake a Suggestion\n\n## How to Use This Tool\n\n**CRITICAL**: This tool requires a `request` parameter containing the request object. All parameters must be passed inside a `request` object.\n\n**Parameter Format**: \n- Always wrap parameters in a `request` object: `{\"request\": {\"portalID\": \"PZ-9999\", \"CreateSuggestion\": {...}}}`\n- Required parameters:\n  - `portalID` (string) - The portal ID (format: 2-4 letter prefix + dash + 4-15 digits, e.g., \"PZ-9999\")\n  - `CreateSuggestion` (object) - The suggestion object with:\n    - `name` (string, **required**) - Name/title of the suggestion\n    - `content` (string, **required**) - Content/description of the suggestion\n    - `language` (object, **required**) - Language object with `code` property (e.g., {\"code\": \"en-US\"})\n  - `acceptLanguage` (string, default: \"en-US\") - Accept-Language header value\n\n- Optional parameters:\n  - `CreateSuggestion` additional optional fields:\n    - `description` (string) - Additional description\n    - `feedbackArticle` (object) - Article ID object if providing feedback on existing article: `{\"id\": \"PROD-2996\"}`\n    - `attachments` (object) - Attachments object\n    - `customAttributes` (array) - Custom attributes array\n\n**Example**: To create a suggestion in portal \"PZ-9999\", call with:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"CreateSuggestion\": {\"name\": \"New Article Request\", \"content\": \"Please add information about loan rates\", \"language\": {\"code\": \"en-US\"}}}}\n```\n\n**Example with feedback on existing article**:\n```json\n{\"request\": {\"portalID\": \"PZ-9999\", \"CreateSuggestion\": {\"name\": \"Article Feedback\", \"content\": \"This article needs updating\", \"language\": {\"code\": \"en-US\"}, \"feedbackArticle\": {\"id\": \"PROD-2996\"}}}}\n```\n\n## Displaying Results (MCP-Specific)\n**CRITICAL**: When this tool returns data successfully, you MUST display the suggestion creation result to the user in your response. Do not silently process the data - always show the user what was returned.\n\n**What to display:**\n- Confirm that the suggestion was successfully created\n- Display the suggestion `id` if returned in the response\n- Show the suggestion `name` and `content` that was submitted\n- If an error occurs, display the error message clearly\n- Provide confirmation message to the user\n\n**Example**: \"Your suggestion '[Suggestion Name]' has been successfully submitted. Suggestion ID: [id]...\"\n\n## Prerequisites\n- Requires a valid portal ID. If you don't have the portal ID, first call 'get-portals' to get available portals.\n- Portal ID format: 2-4 letter prefix + dash + 4-15 digits (e.g., \"EB-123456789\")\n\n## Overview\nThe Make a Suggestion API allows users to create an Article Suggestion from within a knowledge portal. This enables users to submit feedback, request new articles, or suggest improvements to existing content.\n\nUsers can submit suggestions with details about what they're looking for, which helps content creators understand user needs and improve the knowledge base.\n"
+  }
+];

package/src/types/bigint.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4";
+
+export function bigint(): z.ZodType<bigint | string> {
+  return z.union([
+    z.bigint().transform((v) => String(v)),
+    z.string().transform((v, ctx) => {
+      try {
+        return BigInt(v);
+      } catch {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: "Invalid bigint value",
+        });
+        return z.NEVER;
+      }
+    }),
+    z.number().transform((v) => BigInt(Math.trunc(v))),
+    z.union([z.null(), z.undefined()]).transform(() => BigInt(0)),
+  ]);
+}
+
+export function bigintOptional(): z.ZodType<bigint | string | undefined> {
+  return z.union([
+    z.bigint().transform((v) => String(v)),
+    z.string().transform((v, ctx) => {
+      try {
+        return BigInt(v);
+      } catch {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: "Invalid bigint value",
+        });
+        return z.NEVER;
+      }
+    }),
+    z.number().transform((v) => BigInt(Math.trunc(v))),
+    z.undefined(),
+    z.null().transform(() => undefined),
+  ]);
+}
+
+export function bigintNullable(): z.ZodType<bigint | string | null> {
+  return z.union([
+    z.bigint().transform((v) => String(v)),
+    z.string().transform((v, ctx) => {
+      try {
+        return BigInt(v);
+      } catch {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: "Invalid bigint value",
+        });
+        return z.NEVER;
+      }
+    }),
+    z.number().transform((v) => BigInt(Math.trunc(v))),
+    z.null(),
+    z.undefined().transform(() => null),
+  ]);
+}
+
+export function bigintConst<T extends bigint>(value: T): z.ZodType<T> {
+  return z
+    .union([
+      z.bigint(),
+      z.string().transform((v, ctx) => {
+        try {
+          return BigInt(v);
+        } catch {
+          ctx.addIssue({
+            code: z.ZodIssueCode.custom,
+            message: "Invalid bigint value",
+          });
+          return z.NEVER;
+        }
+      }),
+      z.number().transform((v) => BigInt(Math.trunc(v))),
+    ])
+    .refine((v) => v === value, {
+      message: `Value must be ${value}`,
+    })
+    .transform(() => value as T);
+}