nvidia-nim-mcp 1.0.0

package/dist/tools.d.ts

@@ -0,0 +1,624 @@
+import { z } from "zod";
+export declare const ChatMessageSchema: z.ZodObject<{
+    role: z.ZodEnum<["system", "user", "assistant"]>;
+    content: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    role?: "system" | "user" | "assistant";
+    content?: string;
+}, {
+    role?: "system" | "user" | "assistant";
+    content?: string;
+}>;
+export declare const ToolFunctionSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodString;
+    parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    name?: string;
+    description?: string;
+    parameters?: Record<string, unknown>;
+}, {
+    name?: string;
+    description?: string;
+    parameters?: Record<string, unknown>;
+}>;
+export declare const ToolSchema: z.ZodObject<{
+    type: z.ZodLiteral<"function">;
+    function: z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string;
+        description?: string;
+        parameters?: Record<string, unknown>;
+    }, {
+        name?: string;
+        description?: string;
+        parameters?: Record<string, unknown>;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    function?: {
+        name?: string;
+        description?: string;
+        parameters?: Record<string, unknown>;
+    };
+    type?: "function";
+}, {
+    function?: {
+        name?: string;
+        description?: string;
+        parameters?: Record<string, unknown>;
+    };
+    type?: "function";
+}>;
+export declare const ChatCompletionSchema: z.ZodObject<{
+    model: z.ZodOptional<z.ZodString>;
+    messages: z.ZodArray<z.ZodObject<{
+        role: z.ZodEnum<["system", "user", "assistant"]>;
+        content: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }, {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }>, "many">;
+    system_prompt: z.ZodOptional<z.ZodString>;
+    temperature: z.ZodOptional<z.ZodNumber>;
+    top_p: z.ZodOptional<z.ZodNumber>;
+    max_tokens: z.ZodOptional<z.ZodNumber>;
+    stop: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+    frequency_penalty: z.ZodOptional<z.ZodNumber>;
+    presence_penalty: z.ZodOptional<z.ZodNumber>;
+    seed: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    model?: string;
+    messages?: {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }[];
+    system_prompt?: string;
+    temperature?: number;
+    top_p?: number;
+    max_tokens?: number;
+    stop?: string | string[];
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    seed?: number;
+}, {
+    model?: string;
+    messages?: {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }[];
+    system_prompt?: string;
+    temperature?: number;
+    top_p?: number;
+    max_tokens?: number;
+    stop?: string | string[];
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    seed?: number;
+}>;
+export declare const ChatStreamSchema: z.ZodObject<{
+    model: z.ZodOptional<z.ZodString>;
+    messages: z.ZodArray<z.ZodObject<{
+        role: z.ZodEnum<["system", "user", "assistant"]>;
+        content: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }, {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }>, "many">;
+    system_prompt: z.ZodOptional<z.ZodString>;
+    temperature: z.ZodOptional<z.ZodNumber>;
+    top_p: z.ZodOptional<z.ZodNumber>;
+    max_tokens: z.ZodOptional<z.ZodNumber>;
+    stop: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+    frequency_penalty: z.ZodOptional<z.ZodNumber>;
+    presence_penalty: z.ZodOptional<z.ZodNumber>;
+    seed: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    model?: string;
+    messages?: {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }[];
+    system_prompt?: string;
+    temperature?: number;
+    top_p?: number;
+    max_tokens?: number;
+    stop?: string | string[];
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    seed?: number;
+}, {
+    model?: string;
+    messages?: {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }[];
+    system_prompt?: string;
+    temperature?: number;
+    top_p?: number;
+    max_tokens?: number;
+    stop?: string | string[];
+    frequency_penalty?: number;
+    presence_penalty?: number;
+    seed?: number;
+}>;
+export declare const TextGenerationSchema: z.ZodObject<{
+    model: z.ZodOptional<z.ZodString>;
+    prompt: z.ZodString;
+    system_prompt: z.ZodOptional<z.ZodString>;
+    temperature: z.ZodOptional<z.ZodNumber>;
+    max_tokens: z.ZodOptional<z.ZodNumber>;
+    stop: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+}, "strip", z.ZodTypeAny, {
+    model?: string;
+    system_prompt?: string;
+    temperature?: number;
+    max_tokens?: number;
+    stop?: string | string[];
+    prompt?: string;
+}, {
+    model?: string;
+    system_prompt?: string;
+    temperature?: number;
+    max_tokens?: number;
+    stop?: string | string[];
+    prompt?: string;
+}>;
+export declare const EmbeddingsSchema: z.ZodObject<{
+    model: z.ZodOptional<z.ZodString>;
+    input: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
+    encoding_format: z.ZodDefault<z.ZodOptional<z.ZodEnum<["float", "base64"]>>>;
+    truncate: z.ZodDefault<z.ZodOptional<z.ZodEnum<["NONE", "START", "END"]>>>;
+}, "strip", z.ZodTypeAny, {
+    model?: string;
+    input?: string | string[];
+    encoding_format?: "base64" | "float";
+    truncate?: "NONE" | "START" | "END";
+}, {
+    model?: string;
+    input?: string | string[];
+    encoding_format?: "base64" | "float";
+    truncate?: "NONE" | "START" | "END";
+}>;
+export declare const RerankSchema: z.ZodObject<{
+    model: z.ZodOptional<z.ZodString>;
+    query: z.ZodString;
+    passages: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodObject<{
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        text?: string;
+    }, {
+        text?: string;
+    }>]>, "many">;
+    top_k: z.ZodOptional<z.ZodNumber>;
+    truncate: z.ZodDefault<z.ZodOptional<z.ZodEnum<["NONE", "END"]>>>;
+}, "strip", z.ZodTypeAny, {
+    model?: string;
+    truncate?: "NONE" | "END";
+    query?: string;
+    passages?: (string | {
+        text?: string;
+    })[];
+    top_k?: number;
+}, {
+    model?: string;
+    truncate?: "NONE" | "END";
+    query?: string;
+    passages?: (string | {
+        text?: string;
+    })[];
+    top_k?: number;
+}>;
+export declare const FunctionCallingSchema: z.ZodObject<{
+    model: z.ZodOptional<z.ZodString>;
+    messages: z.ZodArray<z.ZodObject<{
+        role: z.ZodEnum<["system", "user", "assistant"]>;
+        content: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }, {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }>, "many">;
+    tools: z.ZodArray<z.ZodObject<{
+        type: z.ZodLiteral<"function">;
+        function: z.ZodObject<{
+            name: z.ZodString;
+            description: z.ZodString;
+            parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        }, "strip", z.ZodTypeAny, {
+            name?: string;
+            description?: string;
+            parameters?: Record<string, unknown>;
+        }, {
+            name?: string;
+            description?: string;
+            parameters?: Record<string, unknown>;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        function?: {
+            name?: string;
+            description?: string;
+            parameters?: Record<string, unknown>;
+        };
+        type?: "function";
+    }, {
+        function?: {
+            name?: string;
+            description?: string;
+            parameters?: Record<string, unknown>;
+        };
+        type?: "function";
+    }>, "many">;
+    tool_choice: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodEnum<["auto", "none"]>, z.ZodObject<{
+        type: z.ZodLiteral<"function">;
+        function: z.ZodObject<{
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name?: string;
+        }, {
+            name?: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        function?: {
+            name?: string;
+        };
+        type?: "function";
+    }, {
+        function?: {
+            name?: string;
+        };
+        type?: "function";
+    }>]>>>;
+    temperature: z.ZodOptional<z.ZodNumber>;
+    max_tokens: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    model?: string;
+    messages?: {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }[];
+    temperature?: number;
+    max_tokens?: number;
+    tools?: {
+        function?: {
+            name?: string;
+            description?: string;
+            parameters?: Record<string, unknown>;
+        };
+        type?: "function";
+    }[];
+    tool_choice?: "auto" | "none" | {
+        function?: {
+            name?: string;
+        };
+        type?: "function";
+    };
+}, {
+    model?: string;
+    messages?: {
+        role?: "system" | "user" | "assistant";
+        content?: string;
+    }[];
+    temperature?: number;
+    max_tokens?: number;
+    tools?: {
+        function?: {
+            name?: string;
+            description?: string;
+            parameters?: Record<string, unknown>;
+        };
+        type?: "function";
+    }[];
+    tool_choice?: "auto" | "none" | {
+        function?: {
+            name?: string;
+        };
+        type?: "function";
+    };
+}>;
+export declare const ListModelsSchema: z.ZodObject<{
+    category: z.ZodDefault<z.ZodOptional<z.ZodEnum<["language", "embedding", "reranking", "vision", "code", "multimodal", "all"]>>>;
+}, "strip", z.ZodTypeAny, {
+    category?: "code" | "language" | "embedding" | "reranking" | "vision" | "multimodal" | "all";
+}, {
+    category?: "code" | "language" | "embedding" | "reranking" | "vision" | "multimodal" | "all";
+}>;
+export declare const ModelInfoSchema: z.ZodObject<{
+    model_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    model_id?: string;
+}, {
+    model_id?: string;
+}>;
+export declare const TOOL_DEFINITIONS: readonly [{
+    readonly name: "chat_completion";
+    readonly description: "Send a multi-turn conversation to a NVIDIA NIM language model and receive a completion. Supports all major open-source LLMs including Llama 3.1, Mistral, Gemma, Qwen, and more.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly model: {
+                readonly type: "string";
+                readonly description: "NIM model ID (optional, uses default if not set)";
+            };
+            readonly messages: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly role: {
+                            readonly type: "string";
+                            readonly enum: readonly ["system", "user", "assistant"];
+                        };
+                        readonly content: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly required: readonly ["role", "content"];
+                };
+                readonly minItems: 1;
+            };
+            readonly system_prompt: {
+                readonly type: "string";
+                readonly description: "System prompt to prepend";
+            };
+            readonly temperature: {
+                readonly type: "number";
+                readonly minimum: 0;
+                readonly maximum: 2;
+            };
+            readonly top_p: {
+                readonly type: "number";
+                readonly minimum: 0;
+                readonly maximum: 1;
+            };
+            readonly max_tokens: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 131072;
+            };
+            readonly stop: {
+                readonly oneOf: readonly [{
+                    readonly type: "string";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                }];
+            };
+            readonly seed: {
+                readonly type: "integer";
+            };
+        };
+        readonly required: readonly ["messages"];
+    };
+}, {
+    readonly name: "text_generation";
+    readonly description: "Generate text from a single prompt (simplified interface). Ideal for one-shot tasks like summarization, translation, extraction, or Q&A.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly model: {
+                readonly type: "string";
+            };
+            readonly prompt: {
+                readonly type: "string";
+                readonly description: "Text prompt";
+            };
+            readonly system_prompt: {
+                readonly type: "string";
+            };
+            readonly temperature: {
+                readonly type: "number";
+                readonly minimum: 0;
+                readonly maximum: 2;
+            };
+            readonly max_tokens: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly maximum: 131072;
+            };
+            readonly stop: {
+                readonly oneOf: readonly [{
+                    readonly type: "string";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                }];
+            };
+        };
+        readonly required: readonly ["prompt"];
+    };
+}, {
+    readonly name: "create_embeddings";
+    readonly description: "Convert text(s) into vector embeddings using NVIDIA NIM embedding models. Useful for semantic search, RAG, clustering, and similarity comparisons.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly model: {
+                readonly type: "string";
+                readonly description: "Embedding model ID (e.g. nvidia/nv-embed-v1)";
+            };
+            readonly input: {
+                readonly oneOf: readonly [{
+                    readonly type: "string";
+                }, {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                }];
+                readonly description: "Text or list of texts to embed";
+            };
+            readonly encoding_format: {
+                readonly type: "string";
+                readonly enum: readonly ["float", "base64"];
+            };
+            readonly truncate: {
+                readonly type: "string";
+                readonly enum: readonly ["NONE", "START", "END"];
+            };
+        };
+        readonly required: readonly ["input"];
+    };
+}, {
+    readonly name: "rerank_passages";
+    readonly description: "Rerank a list of passages by relevance to a query using NVIDIA NIM reranking models. Essential for RAG pipelines to improve retrieval quality.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly model: {
+                readonly type: "string";
+                readonly description: "Reranking model ID";
+            };
+            readonly query: {
+                readonly type: "string";
+                readonly description: "Search query";
+            };
+            readonly passages: {
+                readonly type: "array";
+                readonly items: {
+                    readonly oneOf: readonly [{
+                        readonly type: "string";
+                    }, {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly text: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly required: readonly ["text"];
+                    }];
+                };
+                readonly minItems: 1;
+                readonly maxItems: 100;
+            };
+            readonly top_k: {
+                readonly type: "integer";
+                readonly minimum: 1;
+                readonly description: "Return top K results";
+            };
+            readonly truncate: {
+                readonly type: "string";
+                readonly enum: readonly ["NONE", "END"];
+            };
+        };
+        readonly required: readonly ["query", "passages"];
+    };
+}, {
+    readonly name: "function_calling";
+    readonly description: "Use NIM models with tool/function calling capabilities. The model will decide which function to call and with what arguments.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly model: {
+                readonly type: "string";
+            };
+            readonly messages: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly role: {
+                            readonly type: "string";
+                            readonly enum: readonly ["system", "user", "assistant"];
+                        };
+                        readonly content: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly required: readonly ["role", "content"];
+                };
+            };
+            readonly tools: {
+                readonly type: "array";
+                readonly items: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly type: {
+                            readonly type: "string";
+                            readonly enum: readonly ["function"];
+                        };
+                        readonly function: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                };
+                                readonly description: {
+                                    readonly type: "string";
+                                };
+                                readonly parameters: {
+                                    readonly type: "object";
+                                };
+                            };
+                            readonly required: readonly ["name", "description", "parameters"];
+                        };
+                    };
+                    readonly required: readonly ["type", "function"];
+                };
+            };
+            readonly tool_choice: {
+                readonly oneOf: readonly [{
+                    readonly type: "string";
+                    readonly enum: readonly ["auto", "none"];
+                }, {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly type: {
+                            readonly type: "string";
+                        };
+                        readonly function: {
+                            readonly type: "object";
+                        };
+                    };
+                }];
+            };
+            readonly temperature: {
+                readonly type: "number";
+            };
+            readonly max_tokens: {
+                readonly type: "integer";
+            };
+        };
+        readonly required: readonly ["messages", "tools"];
+    };
+}, {
+    readonly name: "list_models";
+    readonly description: "List available NVIDIA NIM models, optionally filtered by category (language, embedding, reranking, vision, code).";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly category: {
+                readonly type: "string";
+                readonly enum: readonly ["language", "embedding", "reranking", "vision", "code", "multimodal", "all"];
+                readonly description: "Filter by model category";
+            };
+        };
+    };
+}, {
+    readonly name: "get_model_info";
+    readonly description: "Get detailed information about a specific NVIDIA NIM model.";
+    readonly inputSchema: {
+        readonly type: "object";
+        readonly properties: {
+            readonly model_id: {
+                readonly type: "string";
+                readonly description: "The model ID";
+            };
+        };
+        readonly required: readonly ["model_id"];
+    };
+}];