fix: deprecate enableActorAutoLoading in favor of enable-adding-actors, and load tools only if not provided in query parameter (#63)

* fix: replace minimist with yargs-parser, deprecate enableActorAutoLoading in favor of enable-adding-actors, and load tools only if not provided in query parameter

Author: jirispilka

.actor/input_schema.json

@@ -15,7 +15,14 @@
             ]
         },
         "enableActorAutoLoading": {
-            "title": "Enable automatic loading of Actors based on context and use-case (experimental, check if it supported by your client)",
+            "title": "Enable automatic loading of Actors based on context and use-case (experimental, check if it supported by your client) (deprecated, use enableAddingActors instead)",
+            "type": "boolean",
+            "description": "When enabled, the server can dynamically add Actors as tools based on user requests and context. \n\nNote: MCP client must support notification on tool updates. To try it, you can use the [Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-client). This is an experimental feature and may require client-specific support.",
+            "default": false,
+            "editor": "hidden"
+        },
+        "enableAddingActors": {
+            "title": "Enable adding Actors based on context and use-case (experimental, check if it supported by your client)",
             "type": "boolean",
             "description": "When enabled, the server can dynamically add Actors as tools based on user requests and context. \n\nNote: MCP client must support notification on tool updates. To try it, you can use the [Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-client). This is an experimental feature and may require client-specific support.",
             "default": false

README.md

@@ -35,7 +35,7 @@
     "apify": "^3.2.6",
     "apify-client": "^2.11.2",
     "express": "^4.21.2",
-    "minimist": "^1.2.8",
+    "yargs-parser": "^21.1.1",
     "zod": "^3.24.1",
     "zod-to-json-schema": "^3.24.1"
   },
@@ -46,6 +46,7 @@
     "@apify/tsconfig": "^0.1.0",
     "@types/express": "^4.0.0",
     "@types/minimist": "^1.2.5",
+    "@types/yargs-parser": "^21.0.3",
     "dotenv": "^16.4.7",
     "eslint": "^9.17.0",
     "eventsource": "^3.0.2",

package-lock.json

@@ -13,17 +13,27 @@
  */
 
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
-import minimist from 'minimist';
+import parser from 'yargs-parser';
 
 import { log } from './logger.js';
 import { ApifyMcpServer } from './server.js';
 import { getActorDiscoveryTools, getActorAutoLoadingTools } from './tools.js';
 
 log.setLevel(log.LEVELS.ERROR);
 
-const argv = minimist(process.argv.slice(2));
+const argv = parser(process.argv.slice(2), {
+    boolean: [
+        'enable-adding-actors',
+        'enableActorAutoLoading', // deprecated
+    ],
+    string: ['actors'],
+    default: {
+        'enable-adding-actors': false,
+    },
+});
+
+const argEnableAddingActors = argv['enable-adding-actors'] || argv.enableActorAutoLoading || false;
 const argActors = argv.actors?.split(',').map((actor: string) => actor.trim()) || [];
-const argEnableActorAutoLoading = argv.enableActorAutoLoading || false;
 
 if (!process.env.APIFY_TOKEN) {
     log.error('APIFY_TOKEN is required but not set in the environment variables.');
@@ -36,7 +46,7 @@ async function main() {
         ? server.addToolsFromActors(argActors)
         : server.addToolsFromDefaultActors());
     server.updateTools(getActorDiscoveryTools());
-    if (argEnableActorAutoLoading) {
+    if (argEnableAddingActors) {
         server.updateTools(getActorAutoLoadingTools());
     }
     const transport = new StdioServerTransport();

package.json

@@ -1,3 +1,4 @@
+import { log } from './logger.js';
 import type { Input } from './types.js';
 
 /**
@@ -12,8 +13,16 @@ export async function processInput(originalInput: Partial<Input>): Promise<Input
     if (input.actors && typeof input.actors === 'string') {
         input.actors = input.actors.split(',').map((format: string) => format.trim()) as string[];
     }
-    if (!input.enableActorAutoLoading) {
-        input.enableActorAutoLoading = false;
+
+    // enableAddingActors is deprecated, use enableActorAutoLoading instead
+    if (input.enableActorAutoLoading !== undefined && input.enableAddingActors === undefined) {
+        log.warning('enableActorAutoLoading is deprecated, use enableAddingActors instead');
+        input.enableAddingActors = input.enableActorAutoLoading;
+    }
+
+    if (!input.enableAddingActors) {
+        input.enableAddingActors = false;
     }
+
     return input;
 }

src/index.ts

@@ -57,8 +57,9 @@ const actorRun = Actor.isAtHome() ? {
 } : {};
 
 /**
- * Process input parameters and update tools
- * If URL contains query parameter actors, add tools from actors, otherwise add tools from default actors
+ * Process input parameters and update tools.
+ * If URL contains query parameter `actors`, add Actors as tools.
+ * Otherwise, add default Actors but only if there are no tools added yet.
  * @param url
  */
 async function processParamsAndUpdateTools(url: string) {
@@ -68,9 +69,8 @@ async function processParamsAndUpdateTools(url: string) {
     const input = await processInput(params as unknown as Input);
     if (input.actors) {
         await mcpServer.addToolsFromActors(input.actors as string[]);
-    }
-    if (input.enableActorAutoLoading) {
-        mcpServer.updateTools(getActorAutoLoadingTools());
+    } else if (mcpServer.getToolNames().length === 0) {
+        await mcpServer.addToolsFromDefaultActors();
     }
     log.debug(`Server is running in STANDBY mode with the following Actors (tools): ${mcpServer.getToolNames()}.
     To use different Actors, provide them in query parameter "actors" or include them in the Actor Task input.`);
@@ -137,9 +137,8 @@ log.info(`Loaded input: ${JSON.stringify(input)} `);
 
 if (STANDBY_MODE) {
     log.info('Actor is running in the STANDBY mode.');
-    await mcpServer.addToolsFromDefaultActors();
     mcpServer.updateTools(getActorDiscoveryTools());
-    if (input.enableActorAutoLoading) {
+    if (input.enableAddingActors) {
         mcpServer.updateTools(getActorAutoLoadingTools());
     }
     app.listen(PORT, () => {

src/input.ts

@@ -3,6 +3,7 @@ import type { ActorDefaultRunOptions, ActorDefinition } from 'apify-client';
 
 export type Input = {
     actors: string[] | string;
+    enableAddingActors?: boolean;
     enableActorAutoLoading?: boolean;
     maxActorMemoryBytes?: number;
     debugActor?: string;

src/main.ts

@@ -0,0 +1,49 @@
+import { describe, it, expect } from 'vitest';
+
+import { processInput } from '../src/input.js';
+import type { Input } from '../src/types.js';
+
+describe('processInput', () => {
+    it('should handle string actors input and convert to array', async () => {
+        const input: Partial<Input> = {
+            actors: 'actor1, actor2,actor3',
+        };
+        const processed = await processInput(input);
+        expect(processed.actors).toEqual(['actor1', 'actor2', 'actor3']);
+    });
+
+    it('should keep array actors input unchanged', async () => {
+        const input: Partial<Input> = {
+            actors: ['actor1', 'actor2', 'actor3'],
+        };
+        const processed = await processInput(input);
+        expect(processed.actors).toEqual(['actor1', 'actor2', 'actor3']);
+    });
+
+    it('should handle enableActorAutoLoading to set enableAddingActors', async () => {
+        const input: Partial<Input> = {
+            actors: ['actor1'],
+            enableActorAutoLoading: true,
+        };
+        const processed = await processInput(input);
+        expect(processed.enableAddingActors).toBe(true);
+    });
+
+    it('should not override existing enableAddingActors with enableActorAutoLoading', async () => {
+        const input: Partial<Input> = {
+            actors: ['actor1'],
+            enableActorAutoLoading: true,
+            enableAddingActors: false,
+        };
+        const processed = await processInput(input);
+        expect(processed.enableAddingActors).toBe(false);
+    });
+
+    it('should default enableAddingActors to false when not provided', async () => {
+        const input: Partial<Input> = {
+            actors: ['actor1'],
+        };
+        const processed = await processInput(input);
+        expect(processed.enableAddingActors).toBe(false);
+    });
+});