@convertcom/mcp-server 0.0.1-beta.15 → 0.0.1-beta.17

package/build/runtime.d.ts

@@ -1,16 +1,18 @@
 import { Server } from '@modelcontextprotocol/sdk/server/index.js';
-import { type CallToolRequest, type CallToolResult, type Implementation, type ReadResourceResult, type Resource, type Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { RequestHandlerExtra } from '@modelcontextprotocol/sdk/shared/protocol.js';
+import { type CallToolRequest, type CallToolResult, type GetPromptRequest, type ReadResourceRequest, type ClientRequest, type Implementation, type ListResourcesResult, type ReadResourceResult, type Resource, type ServerNotification, type Tool } from '@modelcontextprotocol/sdk/types.js';
 import type { ToolExecutionContext } from './auth-context.js';
 import { type CatalogChangeRequest } from './catalog-change.js';
 import { type KbChunk, type KbDocument, type SearchResult } from './kb-search.js';
 export declare const SERVER_NAME = "convert-api";
-export declare const SERVER_VERSION_FALLBACK = "0.0.1-beta.15";
+export declare const SERVER_VERSION_FALLBACK = "0.0.1-beta.17";
+export declare const MAX_SEARCH_QUERY_CHARACTERS = 500;
 export type ExecutionContextResolver = (extra: any, request: CallToolRequest) => ToolExecutionContext | undefined | Promise<ToolExecutionContext | undefined>;
 export type ToolCatalogContextResolver = (extra: any) => ToolExecutionContext | undefined | Promise<ToolExecutionContext | undefined>;
 export type DocsSearchProvider = {
-    search(query: string, limit?: number): SearchResult[] | Promise<SearchResult[]>;
-    getById(id: string): KbChunk | null | Promise<KbChunk | null>;
-    getDocumentById?(id: string): KbDocument | null | Promise<KbDocument | null>;
+    search(query: string, limit?: number, signal?: AbortSignal): SearchResult[] | Promise<SearchResult[]>;
+    getById(id: string, signal?: AbortSignal): KbChunk | null | Promise<KbChunk | null>;
+    getDocumentById?(id: string, signal?: AbortSignal): KbDocument | null | Promise<KbDocument | null>;
 };
 export type RuntimeLogger = {
     log(event: string, payload?: unknown): void;
@@ -34,6 +36,8 @@ export type RuntimeResourceProvider = {
 };
 export type ConvertMcpRuntimeOptions = {
     docs: DocsSearchProvider;
+    /** Disable only where the serving transport cannot scope list-change delivery safely. */
+    advertiseListChanged?: boolean;
     executionContextResolver?: ExecutionContextResolver;
     toolCatalogContextResolver?: ToolCatalogContextResolver;
     logger?: RuntimeLogger;
@@ -47,12 +51,229 @@ export type ConvertMcpRuntimeOptions = {
     toolExtensions?: RuntimeToolExtension[];
     resourceProvider?: RuntimeResourceProvider;
     toolDecorator?: (tool: Tool) => Tool;
+    /** Bounded authorization-shape cache supplied only by transports with stable configuration. */
+    toolCatalogCache?: Map<string, RuntimeToolCatalogSnapshot>;
+    /** Shares deterministic tool-catalog digests across stateless modern requests. */
+    toolCatalogRevisionCache?: Map<string, Promise<string>>;
+    /** Must cover every dynamic input used by toolDecorator; never include bearer or principal data. */
+    toolCatalogDecoratorCacheKey?: () => string;
     serverInstructions?: string | ((toolSet: string) => string);
     catalogChangeNotifier?: (request: CatalogChangeRequest) => Promise<void>;
 };
+export type RuntimeToolCatalogSnapshot = {
+    tools: Tool[];
+    toolsByName: ReadonlyMap<string, Tool>;
+};
+export type RuntimeRequestExtra = Pick<RequestHandlerExtra<ClientRequest, ServerNotification>, 'sendNotification' | 'signal' | 'requestId'> & {
+    clientInfo?: Implementation;
+};
+export type RuntimeToolResolutionObserver = (tool: Tool | undefined) => void;
 export declare const SERVER_INSTRUCTIONS: string;
 export declare function serverInstructionsForToolSet(toolSet: string, renderToolNames?: readonly string[]): string;
 export declare const canonicalSearchTool: Tool;
 export declare const canonicalFetchTool: Tool;
 export declare function getToolsForClient(toolSet?: string, feedbackEnabled?: boolean, executionContext?: ToolExecutionContext): Tool[];
+export type ConvertMcpServerIdentityOptions = Pick<ConvertMcpRuntimeOptions, 'serverVersion' | 'serverTitle' | 'iconBaseUrl' | 'websiteUrl' | 'toolsForClient' | 'serverInstructions'>;
+export declare function convertMcpServerDefinition(options: ConvertMcpServerIdentityOptions): {
+    implementation: {
+        name: string;
+        version: string;
+        title: string;
+        description: string;
+        websiteUrl: string;
+        icons: {
+            src: string;
+            mimeType?: string | undefined;
+            sizes?: string[] | undefined;
+            theme?: "light" | "dark" | undefined;
+        }[];
+    };
+    options: {
+        capabilities: {
+            tools: {
+                listChanged: boolean;
+            };
+            prompts: {
+                listChanged: boolean;
+            };
+            resources: {
+                listChanged: boolean;
+            };
+        };
+        instructions: string;
+    };
+};
 export declare function createConvertMcpServer(options: ConvertMcpRuntimeOptions): Server;
+export declare function createConvertMcpHandlers(options: ConvertMcpRuntimeOptions, clientInfoFor: (extra: RuntimeRequestExtra) => Implementation | undefined): {
+    listTools: (extra: RuntimeRequestExtra) => Promise<{
+        tools: {
+            inputSchema: {
+                [x: string]: unknown;
+                type: "object";
+                properties?: {
+                    [x: string]: object;
+                } | undefined;
+                required?: string[] | undefined;
+            };
+            name: string;
+            description?: string | undefined;
+            outputSchema?: {
+                [x: string]: unknown;
+                type: "object";
+                properties?: {
+                    [x: string]: object;
+                } | undefined;
+                required?: string[] | undefined;
+            } | undefined;
+            annotations?: {
+                title?: string | undefined;
+                readOnlyHint?: boolean | undefined;
+                destructiveHint?: boolean | undefined;
+                idempotentHint?: boolean | undefined;
+                openWorldHint?: boolean | undefined;
+            } | undefined;
+            execution?: {
+                taskSupport?: "required" | "optional" | "forbidden" | undefined;
+            } | undefined;
+            _meta?: {
+                [x: string]: unknown;
+            } | undefined;
+            icons?: {
+                src: string;
+                mimeType?: string | undefined;
+                sizes?: string[] | undefined;
+                theme?: "light" | "dark" | undefined;
+            }[] | undefined;
+            title?: string | undefined;
+        }[];
+    }>;
+    listResources: (extra: RuntimeRequestExtra) => Promise<ListResourcesResult>;
+    listResourceTemplates: (extra: RuntimeRequestExtra) => Promise<{
+        resourceTemplates: never[];
+    }>;
+    readResource: (request: ReadResourceRequest, extra: RuntimeRequestExtra) => Promise<ReadResourceResult>;
+    listPrompts: (extra: RuntimeRequestExtra) => Promise<{
+        prompts: {
+            name: string;
+            description?: string | undefined;
+            arguments?: {
+                name: string;
+                description?: string | undefined;
+                required?: boolean | undefined;
+            }[] | undefined;
+            _meta?: {
+                [x: string]: unknown;
+            } | undefined;
+            icons?: {
+                src: string;
+                mimeType?: string | undefined;
+                sizes?: string[] | undefined;
+                theme?: "light" | "dark" | undefined;
+            }[] | undefined;
+            title?: string | undefined;
+        }[];
+    }>;
+    getPrompt: (request: GetPromptRequest, extra: RuntimeRequestExtra) => Promise<{
+        [x: string]: unknown;
+        messages: {
+            role: "user" | "assistant";
+            content: {
+                type: "text";
+                text: string;
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+            } | {
+                type: "image";
+                data: string;
+                mimeType: string;
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+            } | {
+                type: "audio";
+                data: string;
+                mimeType: string;
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+            } | {
+                uri: string;
+                name: string;
+                type: "resource_link";
+                description?: string | undefined;
+                mimeType?: string | undefined;
+                size?: number | undefined;
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+                icons?: {
+                    src: string;
+                    mimeType?: string | undefined;
+                    sizes?: string[] | undefined;
+                    theme?: "light" | "dark" | undefined;
+                }[] | undefined;
+                title?: string | undefined;
+            } | {
+                type: "resource";
+                resource: {
+                    uri: string;
+                    text: string;
+                    mimeType?: string | undefined;
+                    _meta?: {
+                        [x: string]: unknown;
+                    } | undefined;
+                } | {
+                    uri: string;
+                    blob: string;
+                    mimeType?: string | undefined;
+                    _meta?: {
+                        [x: string]: unknown;
+                    } | undefined;
+                };
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+            };
+        }[];
+        _meta?: {
+            [x: string]: unknown;
+            progressToken?: string | number | undefined;
+            "io.modelcontextprotocol/related-task"?: {
+                taskId: string;
+            } | undefined;
+        } | undefined;
+        description?: string | undefined;
+    }>;
+    callTool: (request: CallToolRequest, extra: RuntimeRequestExtra, onToolResolved?: RuntimeToolResolutionObserver) => Promise<CallToolResult>;
+};
+export declare function namespaceCompletionTelemetry(response: CallToolResult): {
+    delegate?: string;
+    status?: number;
+    errorType?: string;
+};