@inference-gateway/sdk 0.6.2 → 0.7.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.7.0](https://github.com/inference-gateway/typescript-sdk/compare/v0.6.2...v0.7.0) (2025-05-26)
+
+### ✨ Features
+
+* Implement MCP List Tools ([#13](https://github.com/inference-gateway/typescript-sdk/issues/13)) ([5c0a38c](https://github.com/inference-gateway/typescript-sdk/commit/5c0a38cbe825161c9d5dc1e15f59b31217aebb23))
+
 ## [0.6.2](https://github.com/inference-gateway/typescript-sdk/compare/v0.6.1...v0.6.2) (2025-04-30)
 
 ### ♻️ Improvements

package/README.md

@@ -58,6 +58,32 @@ try {
 }
 ```
 
+### Listing MCP Tools
+
+To list available Model Context Protocol (MCP) tools (only available when EXPOSE_MCP is enabled):
+
+```typescript
+import { InferenceGatewayClient } from '@inference-gateway/sdk';
+
+const client = new InferenceGatewayClient({
+  baseURL: 'http://localhost:8080/v1',
+});
+
+try {
+  const tools = await client.listTools();
+  console.log('Available MCP tools:', tools.data);
+
+  // Each tool has: name, description, server, and optional input_schema
+  tools.data.forEach((tool) => {
+    console.log(`Tool: ${tool.name}`);
+    console.log(`Description: ${tool.description}`);
+    console.log(`Server: ${tool.server}`);
+  });
+} catch (error) {
+  console.error('Error:', error);
+}
+```
+
 ### Creating Chat Completions
 
 To generate content using a model:

package/dist/src/client.d.ts

@@ -1,4 +1,4 @@
-import type { Provider, SchemaChatCompletionMessageToolCall, SchemaCompletionUsage, SchemaCreateChatCompletionRequest, SchemaCreateChatCompletionResponse, SchemaCreateChatCompletionStreamResponse, SchemaError, SchemaListModelsResponse } from './types/generated';
+import type { Provider, SchemaChatCompletionMessageToolCall, SchemaCompletionUsage, SchemaCreateChatCompletionRequest, SchemaCreateChatCompletionResponse, SchemaCreateChatCompletionStreamResponse, SchemaError, SchemaListModelsResponse, SchemaListToolsResponse } from './types/generated';
 interface ChatCompletionStreamCallbacks {
     onOpen?: () => void;
     onChunk?: (chunk: SchemaCreateChatCompletionStreamResponse) => void;
@@ -37,6 +37,11 @@ export declare class InferenceGatewayClient {
      * Lists the currently available models.
      */
     listModels(provider?: Provider): Promise<SchemaListModelsResponse>;
+    /**
+     * Lists the currently available MCP tools.
+     * Only accessible when EXPOSE_MCP is enabled.
+     */
+    listTools(): Promise<SchemaListToolsResponse>;
     /**
      * Creates a chat completion.
      */

package/dist/src/client.js

@@ -77,6 +77,15 @@ class InferenceGatewayClient {
         }
         return this.request('/models', { method: 'GET' }, query);
     }
+    /**
+     * Lists the currently available MCP tools.
+     * Only accessible when EXPOSE_MCP is enabled.
+     */
+    async listTools() {
+        return this.request('/mcp/tools', {
+            method: 'GET',
+        });
+    }
     /**
      * Creates a chat completion.
      */

package/dist/src/types/generated/index.d.ts

@@ -47,6 +47,27 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/mcp/tools': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Lists the currently available MCP tools
+         * @description Lists the currently available MCP tools. Only accessible when EXPOSE_MCP is enabled.
+         *
+         */
+        get: operations['listTools'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/proxy/{provider}/{path}': {
         parameters: {
             query?: never;
@@ -218,6 +239,53 @@ export interface components {
             /** @default [] */
             data: components['schemas']['Model'][];
         };
+        /** @description Response structure for listing MCP tools */
+        ListToolsResponse: {
+            /**
+             * @description Always "list"
+             * @example list
+             */
+            object: string;
+            /**
+             * @description Array of available MCP tools
+             * @default []
+             */
+            data: components['schemas']['MCPTool'][];
+        };
+        /** @description An MCP tool definition */
+        MCPTool: {
+            /**
+             * @description The name of the tool
+             * @example read_file
+             */
+            name: string;
+            /**
+             * @description A description of what the tool does
+             * @example Read content from a file
+             */
+            description: string;
+            /**
+             * @description The MCP server that provides this tool
+             * @example http://mcp-filesystem-server:8083/mcp
+             */
+            server: string;
+            /**
+             * @description JSON schema for the tool's input parameters
+             * @example {
+             *       "type": "object",
+             *       "properties": {
+             *         "file_path": {
+             *           "type": "string",
+             *           "description": "Path to the file to read"
+             *         }
+             *       },
+             *       "required": [
+             *         "file_path"
+             *       ]
+             *     }
+             */
+            input_schema?: Record<string, never>;
+        };
         FunctionObject: {
             /** @description A description of what the function does, used by the model to choose when and how to call the function. */
             description?: string;
@@ -458,6 +526,18 @@ export interface components {
                 'application/json': components['schemas']['Error'];
             };
         };
+        /** @description MCP tools endpoint is not exposed */
+        MCPNotExposed: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                /** @example {
+                 *       "error": "MCP tools endpoint is not exposed. Set EXPOSE_MCP=true to enable."
+                 *     } */
+                'application/json': components['schemas']['Error'];
+            };
+        };
         /** @description ProviderResponse depends on the specific provider and endpoint being called
          *     If you decide to use this approach, please follow the provider-specific documentations.
          *      */
@@ -513,6 +593,8 @@ export type SchemaMessageRole = components['schemas']['MessageRole'];
 export type SchemaMessage = components['schemas']['Message'];
 export type SchemaModel = components['schemas']['Model'];
 export type SchemaListModelsResponse = components['schemas']['ListModelsResponse'];
+export type SchemaListToolsResponse = components['schemas']['ListToolsResponse'];
+export type SchemaMcpTool = components['schemas']['MCPTool'];
 export type SchemaFunctionObject = components['schemas']['FunctionObject'];
 export type SchemaChatCompletionTool = components['schemas']['ChatCompletionTool'];
 export type SchemaFunctionParameters = components['schemas']['FunctionParameters'];
@@ -534,6 +616,7 @@ export type SchemaConfig = components['schemas']['Config'];
 export type ResponseBadRequest = components['responses']['BadRequest'];
 export type ResponseUnauthorized = components['responses']['Unauthorized'];
 export type ResponseInternalError = components['responses']['InternalError'];
+export type ResponseMcpNotExposed = components['responses']['MCPNotExposed'];
 export type ResponseProviderResponse = components['responses']['ProviderResponse'];
 export type RequestBodyProviderRequest = components['requestBodies']['ProviderRequest'];
 export type RequestBodyCreateChatCompletionRequest = components['requestBodies']['CreateChatCompletionRequest'];
@@ -591,6 +674,29 @@ export interface operations {
             500: components['responses']['InternalError'];
         };
     };
+    listTools: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['ListToolsResponse'];
+                };
+            };
+            401: components['responses']['Unauthorized'];
+            403: components['responses']['MCPNotExposed'];
+            500: components['responses']['InternalError'];
+        };
+    };
     proxyGet: {
         parameters: {
             query?: never;

package/dist/tests/client.test.js

@@ -82,6 +82,53 @@ describe('InferenceGatewayClient', () => {
             await expect(client.listModels(generated_1.Provider.openai)).rejects.toThrow(errorMessage);
         });
     });
+    describe('listTools', () => {
+        it('should fetch available MCP tools', async () => {
+            const mockResponse = {
+                object: 'list',
+                data: [
+                    {
+                        name: 'read_file',
+                        description: 'Read content from a file',
+                        server: 'http://mcp-filesystem-server:8083/mcp',
+                    },
+                    {
+                        name: 'write_file',
+                        description: 'Write content to a file',
+                        server: 'http://mcp-filesystem-server:8083/mcp',
+                    },
+                ],
+            };
+            mockFetch.mockResolvedValueOnce({
+                ok: true,
+                json: () => Promise.resolve(mockResponse),
+            });
+            const result = await client.listTools();
+            expect(result).toEqual(mockResponse);
+            expect(mockFetch).toHaveBeenCalledWith('http://localhost:8080/v1/mcp/tools', expect.objectContaining({
+                method: 'GET',
+                headers: expect.any(Headers),
+            }));
+        });
+        it('should throw error when MCP is not exposed', async () => {
+            const errorMessage = 'MCP not exposed';
+            mockFetch.mockResolvedValueOnce({
+                ok: false,
+                status: 403,
+                json: () => Promise.resolve({ error: errorMessage }),
+            });
+            await expect(client.listTools()).rejects.toThrow(errorMessage);
+        });
+        it('should throw error when unauthorized', async () => {
+            const errorMessage = 'Unauthorized';
+            mockFetch.mockResolvedValueOnce({
+                ok: false,
+                status: 401,
+                json: () => Promise.resolve({ error: errorMessage }),
+            });
+            await expect(client.listTools()).rejects.toThrow(errorMessage);
+        });
+    });
     describe('createChatCompletion', () => {
         it('should create a chat completion', async () => {
             const mockRequest = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inference-gateway/sdk",
-  "version": "0.6.2",
+  "version": "0.7.0",
   "description": "An SDK written in Typescript for the [Inference Gateway](https://github.com/inference-gateway/inference-gateway).",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",