@egain/egain-mcp-server 1.0.26 → 1.1.0

package/src/lib/base64.ts

@@ -29,9 +29,9 @@ export function stringFromBase64(b64str: string): string {
 }
 
 export const zodOutbound = z
-  .instanceof(Uint8Array)
+  .custom<Uint8Array>((x) => x instanceof Uint8Array)
   .or(z.string().transform(stringToBytes));
 
 export const zodInbound = z
-  .instanceof(Uint8Array)
+  .custom<Uint8Array>((x) => x instanceof Uint8Array)
   .or(z.string().transform(bytesFromBase64));

package/src/lib/config.ts

@@ -60,10 +60,10 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
   const serverParams: Record<string, Params> = {
     "server_0": {
-      "API_DOMAIN": options.API_DOMAIN ?? "api.aidev.egain.cloud",
+      "API_DOMAIN": options.API_DOMAIN ?? "api.ai.egain.cloud",
     },
     "server_1": {
-      "API_DOMAIN": options.API_DOMAIN ?? "api.aidev.egain.cloud",
+      "API_DOMAIN": options.API_DOMAIN ?? "api.ai.egain.cloud",
     },
   };
 
@@ -82,8 +82,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "1.0.24",
-  genVersion: "2.723.8",
+  sdkVersion: "2.0.1",
+  genVersion: "2.836.5",
   userAgent:
-    "speakeasy-sdk/mcp-typescript 1.0.24 2.723.8 1.0.0 @egain/egain-mcp-server",
+    "speakeasy-sdk/mcp-typescript 2.0.1 2.836.5 1.0.0 @egain/egain-mcp-server",
 } as const;

package/src/lib/encodings.ts

@@ -102,8 +102,9 @@ export function encodeLabel(
       });
       encValue = mapped?.join("").slice(1);
     } else {
-      const k =
-        options?.explode && isPlainObject(value) ? `${encodeString(pk)}=` : "";
+      const k = options?.explode && isPlainObject(value)
+        ? `${encodeString(pk)}=`
+        : "";
       encValue = `${k}${encodeValue(pv)}`;
     }
 
@@ -365,6 +366,12 @@ function serializeValue(value: unknown): string {
   } else if (value instanceof Uint8Array) {
     return bytesToBase64(value);
   } else if (typeof value === "object") {
+    if (
+      "toJSON" in value
+      && typeof value.toJSON === "function"
+    ) {
+      return String(value.toJSON());
+    }
     return JSON.stringify(value, jsonReplacer);
   }
 
@@ -374,6 +381,8 @@ function serializeValue(value: unknown): string {
 function jsonReplacer(_: string, value: unknown): unknown {
   if (value instanceof Uint8Array) {
     return bytesToBase64(value);
+  } else if (typeof value === "bigint") {
+    return value.toString();
   } else {
     return value;
   }
@@ -440,7 +449,7 @@ type BulkQueryEncoder = (
 ) => string;
 
 export function queryEncoder(f: QueryEncoder): BulkQueryEncoder {
-  const bulkEncode = function (
+  const bulkEncode = function(
     values: Record<string, unknown>,
     options?: QueryEncoderOptions,
   ): string {

package/src/lib/matchers.ts

@@ -299,9 +299,13 @@ export function match<T, E>(
       );
       return [result.ok ? { ok: false, error: result.value } : result, raw];
     } else {
+      const valueToParse = resultKey && isPlainObject(data) && resultKey in data
+        ? data[resultKey as keyof typeof data]
+        : data;
+
       return [
         safeParse(
-          data,
+          valueToParse,
           (v: unknown) => matcher.schema.parse(v),
           "Response validation failed",
         ),

package/src/lib/schemas.ts

@@ -2,34 +2,22 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import {
-  output,
-  ZodEffects,
-  ZodError,
-  ZodObject,
-  ZodRawShape,
-  ZodTypeAny,
-} from "zod";
+import * as z from "zod";
 import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
 import { ERR, OK, Result } from "../types/fp.js";
 
 export function collectExtraKeys<
-  Shape extends ZodRawShape,
-  Catchall extends ZodTypeAny,
+  Shape extends z.ZodRawShape,
+  Catchall extends z.ZodType,
   K extends string,
+  Optional extends boolean,
 >(
-  obj: ZodObject<Shape, "strip", Catchall>,
+  obj: z.ZodObject<Shape, z.core.$catchall<Catchall>>,
   extrasKey: K,
-  optional: boolean,
-): ZodEffects<
-  typeof obj,
-  & output<ZodObject<Shape, "strict">>
-  & {
-    [k in K]: Record<string, output<Catchall>>;
-  }
-> {
-  return obj.transform((val) => {
-    const extras: Record<string, output<Catchall>> = {};
+  optional: Optional,
+) {
+  return obj.transform((val: any) => {
+    const extras: Record<string, z.output<Catchall>> = {};
     const { shape } = obj;
     for (const [key] of Object.entries(val)) {
       if (key in shape) {
@@ -66,7 +54,7 @@ export function parse<Inp, Out>(
   try {
     return fn(rawValue);
   } catch (err) {
-    if (err instanceof ZodError) {
+    if (err instanceof z.ZodError) {
       throw new SDKValidationError(errorMessage, err, rawValue);
     }
     throw err;

package/src/lib/sdks.ts

@@ -306,9 +306,9 @@ export class ClientSDK {
   }
 }
 
-const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
+const jsonLikeContentTypeRE = /^(application|text)\/([^+]+\+)*json.*/;
 const jsonlLikeContentTypeRE =
-  /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
+  /^(application|text)\/([^+]+\+)*(jsonl|x-ndjson)\b.*/;
 async function logRequest(logger: Logger | undefined, req: Request) {
   if (!logger) {
     return;

package/src/lib/security.ts

@@ -238,6 +238,27 @@ export function resolveGlobalSecurity(
   security: Partial<Security> | null | undefined,
 ): SecurityState | null {
   return resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "apiKey:header",
+        value: security?.oAuthUser,
+      },
+    ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "apiKey:header",
+        value: security?.oAuthCustomer,
+      },
+    ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "apiKey:header",
+        value: security?.oAuthAnonymousCustomer,
+      },
+    ],
     [
       {
         fieldName: "Authorization",

package/src/mcp-server/cli/start/command.ts

@@ -36,6 +36,37 @@ export const startCommand = buildCommand({
           return z.string().parse(value);
         },
       },
+      mode: {
+        kind: "enum",
+        brief:
+          "Server mode (dynamic: expose list_tools, describe_tool, and execute_tool instead of individual tools)",
+        values: ["dynamic"],
+        optional: true,
+      },
+      "o-auth-user": {
+        kind: "parsed",
+        brief: "Sets the oAuthUser auth field for the API",
+        optional: true,
+        parse: (value) => {
+          return z.string().parse(value);
+        },
+      },
+      "o-auth-customer": {
+        kind: "parsed",
+        brief: "Sets the oAuthCustomer auth field for the API",
+        optional: true,
+        parse: (value) => {
+          return z.string().parse(value);
+        },
+      },
+      "o-auth-anonymous-customer": {
+        kind: "parsed",
+        brief: "Sets the oAuthAnonymousCustomer auth field for the API",
+        optional: true,
+        parse: (value) => {
+          return z.string().parse(value);
+        },
+      },
       "access-token": {
         kind: "parsed",
         brief: "Sets the accessToken auth field for the API",

package/src/mcp-server/cli/start/impl.ts

@@ -5,26 +5,29 @@
 import { SSEServerTransport } from "@modelcontextprotocol/sdk/server/sse.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import express from "express";
-import { SDKOptions } from "../../../lib/config.js";
 import { LocalContext } from "../../cli.js";
 import {
   ConsoleLoggerLevel,
   createConsoleLogger,
 } from "../../console-logger.js";
+import { MCPServerFlags } from "../../flags.js";
 import { createMCPServer } from "../../server.js";
 
-interface StartCommandFlags {
+import { landingPageExpress } from "../../../landing-page.js";
+
+interface StartCommandFlags extends MCPServerFlags {
   readonly transport: "stdio" | "sse";
   readonly port: number;
-  readonly tool?: string[];
-  readonly "access-token"?: string;
-  readonly "server-url"?: string;
-  readonly server?: SDKOptions["server"];
-  readonly "api-domain"?: SDKOptions["API_DOMAIN"];
   readonly "log-level": ConsoleLoggerLevel;
   readonly env?: [string, string][];
 }
 
+interface Session {
+  mcpServer: ReturnType<typeof createMCPServer>["server"];
+  transport: SSEServerTransport;
+  cleanup: () => Promise<void>;
+}
+
 export async function main(this: LocalContext, flags: StartCommandFlags) {
   flags.env?.forEach(([key, value]) => {
     process.env[key] = value;
@@ -45,10 +48,16 @@ export async function main(this: LocalContext, flags: StartCommandFlags) {
 async function startStdio(flags: StartCommandFlags) {
   const logger = createConsoleLogger(flags["log-level"]);
   const transport = new StdioServerTransport();
-  const server = createMCPServer({
+  const { server } = createMCPServer({
     logger,
     allowedTools: flags.tool,
-    security: { accessToken: flags["access-token"] ?? "" },
+    dynamic: flags.mode === "dynamic",
+    security: {
+      oAuthUser: flags["o-auth-user"] ?? "",
+      oAuthCustomer: flags["o-auth-customer"] ?? "",
+      oAuthAnonymousCustomer: flags["o-auth-anonymous-customer"] ?? "",
+      accessToken: flags["access-token"] ?? "",
+    },
     serverURL: flags["server-url"],
     server: flags.server,
     API_DOMAIN: flags["api-domain"],
@@ -63,39 +72,121 @@ async function startStdio(flags: StartCommandFlags) {
   process.on("SIGINT", abort);
 }
 
-async function startSSE(flags: StartCommandFlags) {
-  const logger = createConsoleLogger(flags["log-level"]);
+async function startSSE(cliFlags: StartCommandFlags) {
+  const logger = createConsoleLogger(cliFlags["log-level"]);
   const app = express();
-  const mcpServer = createMCPServer({
-    logger,
-    allowedTools: flags.tool,
-    security: { accessToken: flags["access-token"] ?? "" },
-    serverURL: flags["server-url"],
-    server: flags.server,
-    API_DOMAIN: flags["api-domain"],
-  });
-  let transport: SSEServerTransport | undefined;
+  const sessions = new Map<string, Session>();
   const controller = new AbortController();
 
-  app.get("/sse", async (_req, res) => {
-    transport = new SSEServerTransport("/message", res);
+  app.get("/sse", async (req, res) => {
+    const sessionId = crypto.randomUUID();
+
+    logger.info("SSE connection initiated", {
+      sessionId,
+      userAgent: req.headers["user-agent"],
+    });
+
+    // Track early disconnection
+    let connectionClosed = false;
+    res.on("close", () => {
+      if (!connectionClosed) {
+        logger.info("Connection closed early", { sessionId });
+      }
+      connectionClosed = true;
+    });
+
+    // Merge CLI flags with header overrides for security credentials
+    const flags: StartCommandFlags = {
+      ...cliFlags,
+      // Security fields can be overridden via headers
+      "o-auth-user": (req.headers["oAuthUser"] as string)
+        ?? cliFlags["o-auth-user"],
+      "o-auth-customer": (req.headers["oAuthCustomer"] as string)
+        ?? cliFlags["o-auth-customer"],
+      "o-auth-anonymous-customer":
+        (req.headers["oAuthAnonymousCustomer"] as string)
+          ?? cliFlags["o-auth-anonymous-customer"],
+      "access-token": (req.headers["accessToken"] as string)
+        ?? cliFlags["access-token"],
+    };
+
+    // Create a new MCP server for this connection with its auth
+    const { server: mcpServer } = createMCPServer({
+      logger,
+      allowedTools: flags.tool,
+      dynamic: flags.mode === "dynamic",
+      security: {
+        oAuthUser: flags["o-auth-user"] ?? "",
+        oAuthCustomer: flags["o-auth-customer"] ?? "",
+        oAuthAnonymousCustomer: flags["o-auth-anonymous-customer"] ?? "",
+        accessToken: flags["access-token"] ?? "",
+      },
+      serverURL: flags["server-url"],
+      server: flags.server,
+      API_DOMAIN: flags["api-domain"],
+    });
+
+    // Message path includes session ID for routing
+    const transport = new SSEServerTransport(`/message/${sessionId}`, res);
+
+    const cleanup = async () => {
+      await mcpServer.close();
+    };
+
+    sessions.set(sessionId, { mcpServer, transport, cleanup });
+    logger.info("Session created", { sessionId, totalSessions: sessions.size });
+    controller.signal.addEventListener("abort", cleanup);
+
+    // Log server-side errors for debugging (e.g. tools/list handler failures)
+    mcpServer.server.onerror = (error) => {
+      logger.error("MCP protocol error", {
+        sessionId,
+        error: error instanceof Error ? error.message : String(error),
+        stack: error instanceof Error ? error.stack : undefined,
+      });
+    };
+
+    // Wrap transport.send to log error responses for debugging
+    const originalSend = transport.send.bind(transport);
+    transport.send = async (message) => {
+      if ("error" in message && message.error) {
+        logger.error("MCP sending error response", {
+          sessionId,
+          id: message.id,
+          errorCode: message.error.code,
+          errorMessage: message.error.message,
+        });
+      }
+      return originalSend(message);
+    };
 
     await mcpServer.connect(transport);
 
     mcpServer.server.onclose = async () => {
+      connectionClosed = true;
+      controller.signal.removeEventListener("abort", cleanup);
+      sessions.delete(sessionId);
+      logger.info("Session closed", {
+        sessionId,
+        totalSessions: sessions.size,
+      });
       res.end();
     };
   });
 
-  app.post("/message", async (req, res) => {
-    if (!transport) {
-      throw new Error("Server transport not initialized");
+  app.post("/message/:sessionId", async (req, res) => {
+    const session = sessions.get(req.params.sessionId);
+    if (!session) {
+      res.status(404).send("Session not found");
+      return;
     }
 
-    await transport.handlePostMessage(req, res);
+    await session.transport.handlePostMessage(req, res);
   });
 
-  const httpServer = app.listen(flags.port, "0.0.0.0", () => {
+  app.get("/", landingPageExpress);
+
+  const httpServer = app.listen(cliFlags.port, "0.0.0.0", () => {
     const ha = httpServer.address();
     const host = typeof ha === "string" ? ha : `${ha?.address}:${ha?.port}`;
     logger.info("MCP HTTP server started", { host });
@@ -109,10 +200,6 @@ async function startSSE(flags: StartCommandFlags) {
     }
     closing = true;
 
-    logger.info("Shutting down MCP server");
-
-    await mcpServer.close();
-
     logger.info("Shutting down HTTP server");
 
     const timer = setTimeout(() => {

package/src/mcp-server/extensions.ts

@@ -2,16 +2,18 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { ZodRawShape } from "zod";
-import { PromptArgsRawShape, PromptDefinition } from "./prompts.js";
+import { ZodRawShapeCompat } from "@modelcontextprotocol/sdk/server/zod-compat.js";
+import { PromptDefinition } from "./prompts.js";
 import { ResourceDefinition, ResourceTemplateDefinition } from "./resources.js";
 import { ToolDefinition } from "./tools.js";
 
 export type Register = {
-  tool: <A extends ZodRawShape | undefined>(def: ToolDefinition<A>) => void;
+  tool: <A extends ZodRawShapeCompat | undefined>(
+    def: ToolDefinition<A>,
+  ) => void;
   resource: (def: ResourceDefinition) => void;
   resourceTemplate: (def: ResourceTemplateDefinition) => void;
-  prompt: <A extends PromptArgsRawShape | undefined>(
+  prompt: <A extends ZodRawShapeCompat | undefined>(
     prompt: PromptDefinition<A>,
   ) => void;
 };

package/src/mcp-server/flags.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKOptions } from "../lib/config.js";
+
+/**
+ * Base flags interface for MCP server configuration.
+ * Used by both CLI start command and Gram deployment wrapper.
+ */
+export interface MCPServerFlags {
+  readonly tool?: string[];
+  readonly mode?: "dynamic" | undefined;
+  readonly "o-auth-user"?: string | undefined;
+  readonly "o-auth-customer"?: string | undefined;
+  readonly "o-auth-anonymous-customer"?: string | undefined;
+  readonly "access-token"?: string | undefined;
+  readonly "server-url"?: string | undefined;
+  readonly server?: SDKOptions["server"];
+  readonly "api-domain"?: SDKOptions["API_DOMAIN"];
+}

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

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

package/src/mcp-server/prompts.ts

@@ -3,40 +3,30 @@
  */
 
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import {
+  ShapeOutput,
+  ZodRawShapeCompat,
+} from "@modelcontextprotocol/sdk/server/zod-compat.js";
 import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
 import {
   GetPromptResult,
   ServerNotification,
   ServerRequest,
 } from "@modelcontextprotocol/sdk/types.js";
-import {
-  objectOutputType,
-  ZodOptional,
-  ZodType,
-  ZodTypeAny,
-  ZodTypeDef,
-} from "zod";
 import { EgainMcpCore } from "../core.js";
 import { ConsoleLogger } from "./console-logger.js";
 import { MCPScope } from "./scopes.js";
 
-// '@modelcontextprotocol/sdk' currently does not export this type
-export type PromptArgsRawShape = {
-  [k: string]:
-    | ZodType<string, ZodTypeDef, string>
-    | ZodOptional<ZodType<string, ZodTypeDef, string>>;
-};
-
 export type PromptDefinition<
-  Args extends undefined | PromptArgsRawShape = undefined,
-> = Args extends PromptArgsRawShape ? {
+  Args extends undefined | ZodRawShapeCompat = undefined,
+> = Args extends ZodRawShapeCompat ? {
     name: string;
     description?: string;
     scopes?: MCPScope[];
     args: Args;
     prompt: (
       client: EgainMcpCore,
-      args: objectOutputType<Args, ZodTypeAny>,
+      args: ShapeOutput<Args>,
       extra: RequestHandlerExtra<ServerRequest, ServerNotification>,
     ) => GetPromptResult | Promise<GetPromptResult>;
   }
@@ -71,10 +61,10 @@ export function createRegisterPrompt(
   server: McpServer,
   getSDK: () => EgainMcpCore,
   allowedScopes: Set<MCPScope>,
-): <A extends PromptArgsRawShape | undefined>(
+): <A extends ZodRawShapeCompat | undefined>(
   prompt: PromptDefinition<A>,
 ) => void {
-  return <A extends PromptArgsRawShape | undefined>(
+  return <A extends ZodRawShapeCompat | undefined>(
     prompt: PromptDefinition<A>,
   ): void => {
     const scopes = prompt.scopes ?? [];

package/src/mcp-server/server.ts

@@ -12,19 +12,20 @@ import {
   createRegisterResourceTemplate,
 } from "./resources.js";
 import { MCPScope } from "./scopes.js";
-import { createRegisterTool } from "./tools.js";
-import { tool$getAnnouncements } from "./tools/getAnnouncements.js";
-import { tool$getArticle } from "./tools/getArticle.js";
+import { createRegisterTool, registerDynamicTools } from "./tools.js";
+import { tool$aiSearch } from "./tools/aiSearch.js";
+import { tool$getAnnouncementArticles } from "./tools/getAnnouncementArticles.js";
+import { tool$getArticleById } from "./tools/getArticleById.js";
+import { tool$getBestAnswer } from "./tools/getBestAnswer.js";
+import { tool$getMyPortals } from "./tools/getMyPortals.js";
 import { tool$getPopularArticles } from "./tools/getPopularArticles.js";
-import { tool$getPortals } from "./tools/getPortals.js";
 import { tool$makeSuggestion } from "./tools/makeSuggestion.js";
-import { tool$queryAnswers } from "./tools/queryAnswers.js";
-import { tool$queryRetrieve } from "./tools/queryRetrieve.js";
-import { tool$querySearch } from "./tools/querySearch.js";
+import { tool$retrieveChunks } from "./tools/retrieveChunks.js";
 
 export function createMCPServer(deps: {
   logger: ConsoleLogger;
   allowedTools?: string[] | undefined;
+  dynamic?: boolean | undefined;
   scopes?: MCPScope[] | undefined;
   getSDK?: () => EgainMcpCore;
   serverURL?: string | undefined;
@@ -34,7 +35,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "EgainMcp",
-    version: "1.0.24",
+    version: "2.0.1",
   });
 
   const getClient = deps.getSDK || (() =>
@@ -55,12 +56,13 @@ export function createMCPServer(deps: {
   const scopes = new Set(deps.scopes);
 
   const allowedTools = deps.allowedTools && new Set(deps.allowedTools);
-  const tool = createRegisterTool(
+  const [tool, tools, toolMap] = createRegisterTool(
     deps.logger,
     server,
     getClient,
     scopes,
     allowedTools,
+    deps.dynamic,
   );
   const resource = createRegisterResource(
     deps.logger,
@@ -78,14 +80,18 @@ export function createMCPServer(deps: {
   const register = { tool, resource, resourceTemplate, prompt };
   void register; // suppress unused warnings
 
-  tool(tool$queryRetrieve);
-  tool(tool$queryAnswers);
-  tool(tool$getArticle);
-  tool(tool$getAnnouncements);
+  tool(tool$retrieveChunks);
+  tool(tool$getBestAnswer);
+  tool(tool$getArticleById);
+  tool(tool$getAnnouncementArticles);
   tool(tool$getPopularArticles);
-  tool(tool$getPortals);
-  tool(tool$querySearch);
+  tool(tool$getMyPortals);
+  tool(tool$aiSearch);
   tool(tool$makeSuggestion);
 
-  return server;
+  if (deps.dynamic) {
+    registerDynamicTools(deps.logger, server, getClient, toolMap, scopes);
+  }
+
+  return { server, tools };
 }