mcp-meilisearch 1.2.0 → 1.2.1

package/dist/client.d.ts

@@ -1,5 +1,13 @@
 export declare class MCPClient {
+    /**
+     * Indicates whether the client is connected to the MCP server
+     * Used to track the connection state and control async operations
+     */
     isConnected: boolean;
+    /**
+     * List of available tools provided by the MCP server
+     * Each tool has a name and description
+     */
     tools: {
         name: string;
         description: string;
@@ -9,20 +17,46 @@ export declare class MCPClient {
     private transport;
     private toolsUpdatedCallback;
     constructor(serverName: string);
+    /**
+     * Registers a callback to be called when the list of available tools changes
+     * @param callback The function to call when tools are updated
+     */
     onToolsUpdatedCallback(callback: (tools: Array<{
         name: string;
         description: string;
     }>) => void): void;
+    /**
+     * Executes the provided callback once the client is connected to the server
+     * Waits in a loop until the connection is established
+     * @param callback The function to execute after connection is established
+     * @returns The result of the callback function
+     */
     onConnected<T>(callback: () => T | Promise<T>): Promise<T>;
+    /**
+     * Connects to the MCP server with retry logic
+     * @param serverUrl The URL of the MCP server to connect to
+     * @throws Error if connection fails after 5 attempts
+     */
     connectToServer(serverUrl: string): Promise<void>;
     private listTools;
     private setUpNotifications;
+    /**
+     * Calls a tool on the MCP server with optional arguments
+     * Parses and processes the response from the server
+     * @param name The name of the tool to call
+     * @param args Optional arguments to pass to the tool
+     * @returns Object containing success status and either data or error message
+     */
     callTool(name: string, args?: Record<string, any>): Promise<{
         success: boolean;
         data?: any;
         error?: string;
     }>;
     private setUpTransport;
+    /**
+     * Closes the connection to the server and resets the connection state
+     * Called automatically on transport error or can be called manually
+     */
     cleanup(): Promise<void>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAQA,qBAAa,SAAS;IACpB,WAAW,EAAE,OAAO,CAAS;IAC7B,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EAAE,CAAM;IAEpD,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,SAAS,CAA8C;IAC/D,OAAO,CAAC,oBAAoB,CAEZ;gBAEJ,UAAU,EAAE,MAAM;IAIvB,sBAAsB,CAC3B,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,KAAK,IAAI;IAKnE,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAO1D,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAsBzC,SAAS;IAuBvB,OAAO,CAAC,kBAAkB;IAWpB,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACzB,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE,GAAG,CAAC;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IAoCF,OAAO,CAAC,cAAc;IAKhB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAK/B"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAQA,qBAAa,SAAS;IACpB;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAS;IAE7B;;;OAGG;IACH,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EAAE,CAAM;IAEpD,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,KAAK,CAAa;IAC1B,OAAO,CAAC,SAAS,CAA8C;IAC/D,OAAO,CAAC,oBAAoB,CAEZ;gBAEJ,UAAU,EAAE,MAAM;IAI9B;;;OAGG;IACH,sBAAsB,CACpB,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC,KAAK,IAAI;IAKzE;;;;;OAKG;IACG,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAOhE;;;;OAIG;IACG,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAsBzC,SAAS;IAuBvB,OAAO,CAAC,kBAAkB;IAW1B;;;;;;OAMG;IACG,QAAQ,CACZ,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACzB,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE,GAAG,CAAC;QACX,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IAoCF,OAAO,CAAC,cAAc;IAKtB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAK/B"}

package/dist/client.js

@@ -2,7 +2,15 @@ import { Client } from "@modelcontextprotocol/sdk/client/index.js";
 import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
 import { TextContentSchema, LoggingMessageNotificationSchema, ToolListChangedNotificationSchema, } from "@modelcontextprotocol/sdk/types.js";
 export class MCPClient {
+    /**
+     * Indicates whether the client is connected to the MCP server
+     * Used to track the connection state and control async operations
+     */
     isConnected = false;
+    /**
+     * List of available tools provided by the MCP server
+     * Each tool has a name and description
+     */
     tools = [];
     client;
     tries = 0;
@@ -11,15 +19,30 @@ export class MCPClient {
     constructor(serverName) {
         this.client = new Client({ name: serverName, version: "1.0.0" });
     }
+    /**
+     * Registers a callback to be called when the list of available tools changes
+     * @param callback The function to call when tools are updated
+     */
     onToolsUpdatedCallback(callback) {
         this.toolsUpdatedCallback = callback;
     }
+    /**
+     * Executes the provided callback once the client is connected to the server
+     * Waits in a loop until the connection is established
+     * @param callback The function to execute after connection is established
+     * @returns The result of the callback function
+     */
     async onConnected(callback) {
         while (!this.isConnected) {
             await new Promise((resolve) => setTimeout(resolve));
         }
         return callback();
     }
+    /**
+     * Connects to the MCP server with retry logic
+     * @param serverUrl The URL of the MCP server to connect to
+     * @throws Error if connection fails after 5 attempts
+     */
     async connectToServer(serverUrl) {
         const url = new URL(serverUrl);
         try {
@@ -69,6 +92,13 @@ export class MCPClient {
         this.client.setNotificationHandler(LoggingMessageNotificationSchema, console.info);
         this.client.setNotificationHandler(ToolListChangedNotificationSchema, this.listTools);
     }
+    /**
+     * Calls a tool on the MCP server with optional arguments
+     * Parses and processes the response from the server
+     * @param name The name of the tool to call
+     * @param args Optional arguments to pass to the tool
+     * @returns Object containing success status and either data or error message
+     */
     async callTool(name, args) {
         try {
             const result = await this.client.callTool({ name, arguments: args });
@@ -106,6 +136,10 @@ export class MCPClient {
             return;
         this.transport.onerror = this.cleanup;
     }
+    /**
+     * Closes the connection to the server and resets the connection state
+     * Called automatically on transport error or can be called manually
+     */
     async cleanup() {
         if (this.client == null)
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-meilisearch",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Model Context Protocol (MCP) implementation for Meilisearch",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
     "build": "tsc && tsc --project tsconfig.types.json",
     "demo": "npm run build & npm run dev --workspace=demo",
     "server": "npm run build && node --env-file=.env dist/index.js",
-    "prepublishOnly": "rm -rf dist && npm version minor && npm run build"
+    "prepublishOnly": "rm -rf dist && npm version patch && npm run build"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.10.1",