@salesforce/mcp 0.17.1-dev.0 → 0.17.1

package/lib/{shared → modules/platform-cli/utils}/tools.js

@@ -13,76 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import Cache from './cache.js';
-export const TOOLSETS = ['orgs', 'data', 'users', 'metadata', 'testing', 'experimental'];
-/*
- * These are tools that are always enabled at startup. They cannot be disabled and they cannot be dynamically enabled.
- */
-export const CORE_TOOLS = [
-    'sf-get-username',
-    'sf-resume',
-    'sf-enable-tools',
-    'sf-list-tools',
-    'sf-suggest-cli-command',
-];
-/**
- * Determines which toolsets should be enabled based on the provided toolsets array and dynamic tools flag.
- *
- * @param {Array<Toolset | 'all'>} toolsets - Array of toolsets to enable. Can include 'all' to enable all non-experimental toolsets.
- * @param {boolean} dynamicTools - Flag indicating whether dynamic tools should be enabled. When true, only core and dynamic toolsets are enabled.
- * @returns {Record<Toolset | 'dynamic' | 'core', boolean>} Object mapping each toolset to a boolean indicating whether it should be enabled.
- *
- * @example
- * // Enable all toolsets except experimental
- * determineToolsetsToEnable(['all'], false)
- * // Returns: { core: true, data: true, dynamic: false, experimental: false, metadata: true, orgs: true, testing: true, users: true }
- *
- * @example
- * // Enable only dynamic tools
- * determineToolsetsToEnable([], true)
- * // Returns: { core: true, data: false, dynamic: true, experimental: false, metadata: false, orgs: false, testing: false, users: false }
- *
- * @example
- * // Enable specific toolsets
- * determineToolsetsToEnable(['data', 'users'], false)
- * // Returns: { core: true, data: true, dynamic: false, experimental: false, metadata: false, orgs: false, testing: false, users: true }
- */
-export function determineToolsetsToEnable(toolsets, dynamicTools) {
-    if (dynamicTools) {
-        return {
-            core: true,
-            data: true,
-            dynamic: true,
-            experimental: false,
-            metadata: true,
-            orgs: true,
-            testing: true,
-            users: true,
-        };
-    }
-    if (toolsets.includes('all')) {
-        return {
-            core: true,
-            data: true,
-            dynamic: false,
-            experimental: false,
-            metadata: true,
-            orgs: true,
-            testing: true,
-            users: true,
-        };
-    }
-    return {
-        core: true,
-        data: toolsets.includes('data'),
-        dynamic: false,
-        experimental: toolsets.includes('experimental'),
-        metadata: toolsets.includes('metadata'),
-        orgs: toolsets.includes('orgs'),
-        testing: toolsets.includes('testing'),
-        users: toolsets.includes('users'),
-    };
-}
+import Cache from '../../../shared/cache.js';
 /**
  * Add a tool to the cache
  */

package/lib/{shared/tools.d.ts → registry.d.ts}

@@ -1,4 +1,4 @@
-import { RegisteredTool } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { SfMcpServer } from './sf-mcp-server.js';
 export declare const TOOLSETS: readonly ["orgs", "data", "users", "metadata", "testing", "experimental"];
 type Toolset = (typeof TOOLSETS)[number];
 export declare const CORE_TOOLS: string[];
@@ -25,44 +25,5 @@ export declare const CORE_TOOLS: string[];
  * // Returns: { core: true, data: true, dynamic: false, experimental: false, metadata: false, orgs: false, testing: false, users: true }
  */
 export declare function determineToolsetsToEnable(toolsets: Array<Toolset | 'all'>, dynamicTools: boolean): Record<Toolset | 'dynamic' | 'core', boolean>;
-/**
- * Add a tool to the cache
- */
-export declare function addTool(tool: RegisteredTool, name: string): Promise<{
-    success: boolean;
-    message: string;
-}>;
-/**
- * Enable an individual tool
- */
-export declare function enableTool(toolName: string): Promise<{
-    success: boolean;
-    message: string;
-}>;
-export declare function enableTools(tools: string[]): Promise<Array<{
-    success: boolean;
-    message: string;
-}>>;
-/**
- * Disable an individual tool
- */
-export declare function disableTool(toolName: string): Promise<{
-    success: boolean;
-    message: string;
-}>;
-/**
- * Get individual tool status
- */
-export declare function getToolStatus(toolName: string): Promise<{
-    enabled: boolean;
-    description: string;
-} | undefined>;
-/**
- * List all individual tools with their status
- */
-export declare function listAllTools(): Promise<Array<{
-    name: string;
-    enabled: boolean;
-    description: string;
-}>>;
+export declare function registerToolsets(toolsets: Array<Toolset | 'all'>, dynamicTools: boolean, server: SfMcpServer): void;
 export {};

package/lib/registry.js

@@ -0,0 +1,130 @@
+/*
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ux } from '@oclif/core';
+import * as platformCli from './modules/platform-cli/index.js';
+export const TOOLSETS = ['orgs', 'data', 'users', 'metadata', 'testing', 'experimental'];
+/*
+ * These are tools that are always enabled at startup. They cannot be disabled and they cannot be dynamically enabled.
+ *
+ * If you are added a new core tool, please add it to this list so that the SfMcpServer knows about it.
+ */
+export const CORE_TOOLS = [
+    'sf-get-username',
+    'sf-resume',
+    'sf-enable-tools',
+    'sf-list-tools',
+    'sf-suggest-cli-command',
+];
+/**
+ * The tool registry maps toolsets to functions that register tools with the server.
+ *
+ * When adding a new tool, you must add it to the appropriate toolset in this registry.
+ */
+const TOOL_REGISTRY = {
+    core: [platformCli.getUsername, platformCli.resume, platformCli.suggestCliCommand],
+    dynamic: [platformCli.enableTools, platformCli.listTools],
+    orgs: [platformCli.listAllOrgs],
+    data: [platformCli.queryOrg],
+    users: [platformCli.assignPermissionSet],
+    testing: [platformCli.testAgent, platformCli.testApex],
+    metadata: [platformCli.deployMetadata, platformCli.retrieveMetadata],
+    experimental: [
+        platformCli.orgOpen,
+        platformCli.createScratchOrg,
+        platformCli.deleteOrg,
+        platformCli.createOrgSnapshot,
+    ],
+};
+/**
+ * Determines which toolsets should be enabled based on the provided toolsets array and dynamic tools flag.
+ *
+ * @param {Array<Toolset | 'all'>} toolsets - Array of toolsets to enable. Can include 'all' to enable all non-experimental toolsets.
+ * @param {boolean} dynamicTools - Flag indicating whether dynamic tools should be enabled. When true, only core and dynamic toolsets are enabled.
+ * @returns {Record<Toolset | 'dynamic' | 'core', boolean>} Object mapping each toolset to a boolean indicating whether it should be enabled.
+ *
+ * @example
+ * // Enable all toolsets except experimental
+ * determineToolsetsToEnable(['all'], false)
+ * // Returns: { core: true, data: true, dynamic: false, experimental: false, metadata: true, orgs: true, testing: true, users: true }
+ *
+ * @example
+ * // Enable only dynamic tools
+ * determineToolsetsToEnable([], true)
+ * // Returns: { core: true, data: false, dynamic: true, experimental: false, metadata: false, orgs: false, testing: false, users: false }
+ *
+ * @example
+ * // Enable specific toolsets
+ * determineToolsetsToEnable(['data', 'users'], false)
+ * // Returns: { core: true, data: true, dynamic: false, experimental: false, metadata: false, orgs: false, testing: false, users: true }
+ */
+export function determineToolsetsToEnable(toolsets, dynamicTools) {
+    if (dynamicTools) {
+        return {
+            core: true,
+            data: true,
+            dynamic: true,
+            experimental: false,
+            metadata: true,
+            orgs: true,
+            testing: true,
+            users: true,
+        };
+    }
+    if (toolsets.includes('all')) {
+        return {
+            core: true,
+            data: true,
+            dynamic: false,
+            experimental: false,
+            metadata: true,
+            orgs: true,
+            testing: true,
+            users: true,
+        };
+    }
+    return {
+        core: true,
+        data: toolsets.includes('data'),
+        dynamic: false,
+        experimental: toolsets.includes('experimental'),
+        metadata: toolsets.includes('metadata'),
+        orgs: toolsets.includes('orgs'),
+        testing: toolsets.includes('testing'),
+        users: toolsets.includes('users'),
+    };
+}
+function registerToolset(toolset, server) {
+    if (TOOL_REGISTRY[toolset]) {
+        for (const tool of TOOL_REGISTRY[toolset]) {
+            tool(server);
+        }
+    }
+    else {
+        throw new Error(`Failed to register toolset ${toolset}.`);
+    }
+}
+export function registerToolsets(toolsets, dynamicTools, server) {
+    const toolsetsToEnable = determineToolsetsToEnable(toolsets, dynamicTools);
+    for (const toolset of ['core', 'dynamic', ...TOOLSETS]) {
+        if (!toolsetsToEnable[toolset]) {
+            ux.stderr(`Skipping registration of ${toolset} tools`);
+            continue;
+        }
+        ux.stderr(`Registering ${toolset} tools`);
+        registerToolset(toolset, server);
+    }
+}
+//# sourceMappingURL=registry.js.map

package/lib/sf-mcp-server.js

@@ -15,8 +15,9 @@
  */
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { Logger } from '@salesforce/core';
-import { addTool, CORE_TOOLS } from './shared/tools.js';
+import { addTool } from './modules/platform-cli/utils/tools.js';
 import { createRateLimiter } from './shared/rate-limiter.js';
+import { CORE_TOOLS } from './registry.js';
 /**
  * A server implementation that extends the base MCP server with telemetry and rate limiting capabilities.
  *