@salesforce/mcp 0.7.0 → 0.8.2

package/README.md

@@ -158,6 +158,7 @@ These are the available toolsets:
 - `data` - [Tools to manage the data in your org, such as listing all accounts.](README.md#data-toolset)
 - `users` - [Tools to manage org users, such as assigning a permission set.](README.md#users-toolset)
 - `metadata` - [Tools to deploy and retrieve metadata to and from your org and your DX project.](README.md#metadata-toolset)
+- `testing` - [Tools to test your code and features](README.md#testing-toolset)
 
 This example shows how to enable the `data`, `orgs`, and `metadata` toolsets when configuring the MCP server for VS Code:
 
@@ -203,6 +204,14 @@ Includes these tools:
 
 - `sf-deploy-metadata` - Deploys metadata from your DX project to an org.
 - `sf-retrieve-metadata` - Retrieves metadata from your org to your DX project.
+-
+
+#### Testing Toolset
+
+Includes these tools:
+
+- `sf-test-agents` - Executes agent tests in your org.
+- `sf-test-apex` - Executes apex tests in your org
 
 ## Configure Other Clients to Use the Salesforce DX MCP Server
 

package/lib/index.js

@@ -129,8 +129,6 @@ You can also use special values to control access to orgs:
                 tools: {},
             },
         }, { telemetry: this.telemetry });
-        // // TODO: Should we add annotations to our tools? https://modelcontextprotocol.io/docs/concepts/tools#tool-definition-structure
-        // // TODO: Move tool names into a shared file, that way if we reference them in multiple places, we can update them in one place
         const enabledToolsets = new Set(flags.toolsets);
         const all = enabledToolsets.has('all');
         // ************************

package/lib/shared/utils.d.ts

@@ -8,4 +8,4 @@ export declare function textResponse(text: string, isError?: boolean): ToolTextR
  * @returns A Set of enabled toolsets
  */
 export declare function getEnabledToolsets(availableToolsets: string[], toolsetsInput: string): Set<string>;
-export declare function sanitizePath(path: string): boolean;
+export declare function sanitizePath(projectPath: string): boolean;

package/lib/shared/utils.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 /* eslint-disable no-console */
-import { sep } from 'node:path';
+import path from 'node:path';
 // TODO: break into two helpers? One for errors and one for success?
 export function textResponse(text, isError = false) {
     if (text === '')
@@ -52,20 +52,20 @@ export function getEnabledToolsets(availableToolsets, toolsetsInput) {
     console.error('Enabling toolsets:', Array.from(enabledToolsets).join(', '));
     return enabledToolsets;
 }
-export function sanitizePath(path) {
+export function sanitizePath(projectPath) {
     // Decode URL-encoded sequences
-    const decodedPath = decodeURIComponent(path);
+    const decodedProjectPath = decodeURIComponent(projectPath);
     // Normalize Unicode characters
-    const normalizedPath = decodedPath.normalize();
+    const normalizedProjectPath = decodedProjectPath.normalize();
     // Check for various traversal patterns
-    const hasTraversal = normalizedPath.includes('..') ||
-        normalizedPath.includes('\\..') ||
-        normalizedPath.includes('../') ||
-        normalizedPath.includes('..\\') ||
-        normalizedPath.includes('\u2025') || // Unicode horizontal ellipsis
-        normalizedPath.includes('\u2026'); // Unicode vertical ellipsis
-    // Ensure path is absolute
-    const isAbsolute = path.startsWith(sep);
+    const hasTraversal = normalizedProjectPath.includes('..') ||
+        normalizedProjectPath.includes('\u2025') || // Unicode horizontal ellipsis
+        normalizedProjectPath.includes('\u2026'); // Unicode vertical ellipsis
+    // `path.isAbsolute` doesn't cover Windows's drive-relative path:
+    // https://github.com/nodejs/node/issues/56766
+    //
+    // we can assume it's a drive-relative path if it's starts with `\`.
+    const isAbsolute = path.isAbsolute(projectPath) && (process.platform === 'win32' ? !projectPath.startsWith('\\') : true);
     return !hasTraversal && isAbsolute;
 }
 //# sourceMappingURL=utils.js.map

package/lib/tools/core/sf-get-username.js

@@ -69,7 +69,11 @@ This tool handles three distinct scenarios:
 EXAMPLE USAGE:
 - When user says "Do X for my org" → defaultTargetOrg=false, defaultDevHub=false
 - When user says "For my default org" → defaultTargetOrg=true
-- When user says "For my default dev hub" → defaultDevHub=true`, getUsernameParamsSchema.shape, async ({ defaultTargetOrg, defaultDevHub, directory }) => {
+- When user says "For my default dev hub" → defaultDevHub=true`, getUsernameParamsSchema.shape, {
+        title: 'Get Username',
+        readOnlyHint: true,
+        openWorldHint: false,
+    }, async ({ defaultTargetOrg, defaultDevHub, directory }) => {
         try {
             process.chdir(directory);
             const generateResponse = (defaultFromConfig) => textResponse(`ALWAYS notify the user the following 3 (maybe 4) pieces of information:

package/lib/tools/core/sf-resume.js

@@ -63,7 +63,10 @@ Resume the deployment to my org
 Resume scratch org creation
 Resume job 2SR1234567890
 Resume agent tests
-`, resumeParamsSchema.shape, async ({ jobId, wait, usernameOrAlias, directory }) => {
+`, resumeParamsSchema.shape, {
+        title: 'Resume',
+        openWorldHint: false,
+    }, async ({ jobId, wait, usernameOrAlias, directory }) => {
         if (!jobId) {
             return textResponse('The jobId parameter is required.', true);
         }

package/lib/tools/data/sf-query-org.js

@@ -35,7 +35,11 @@ export const queryOrgParamsSchema = z.object({
     directory: directoryParam,
 });
 export const registerToolQueryOrg = (server) => {
-    server.tool('sf-query-org', 'Run a SOQL query against a Salesforce org.', queryOrgParamsSchema.shape, async ({ query, usernameOrAlias, directory }) => {
+    server.tool('sf-query-org', 'Run a SOQL query against a Salesforce org.', queryOrgParamsSchema.shape, {
+        title: 'Query Org',
+        openWorldHint: false,
+        readOnlyHint: true,
+    }, async ({ query, usernameOrAlias, directory }) => {
         try {
             if (!usernameOrAlias)
                 return textResponse('The usernameOrAlias parameter is required, if the user did not specify one use the #sf-get-username tool', true);

package/lib/tools/metadata/sf-deploy-metadata.js

@@ -82,7 +82,11 @@ Deploy this file to my org
 Deploy the manifest
 Deploy X metadata to my org
 Deploy X to my org and run A,B and C apex tests.
-`, deployMetadataParams.shape, async ({ sourceDir, usernameOrAlias, apexTests, apexTestLevel, directory, manifest }) => {
+`, deployMetadataParams.shape, {
+        title: 'Deploy Metadata',
+        destructiveHint: true,
+        openWorldHint: false,
+    }, async ({ sourceDir, usernameOrAlias, apexTests, apexTestLevel, directory, manifest }) => {
         if (apexTests && apexTestLevel) {
             return textResponse("You can't specify both `apexTests` and `apexTestLevel` parameters.", true);
         }

package/lib/tools/metadata/sf-retrieve-metadata.js

@@ -55,7 +55,11 @@ Retrieve changes from my org
 Retrieve this file from my org
 Retrieve the metadata in the manifest
 Retrieve X metadata from my org
-`, retrieveMetadataParams.shape, async ({ sourceDir, usernameOrAlias, directory, manifest }) => {
+`, retrieveMetadataParams.shape, {
+        title: 'Retrieve Metadata',
+        openWorldHint: false,
+        destructiveHint: true,
+    }, async ({ sourceDir, usernameOrAlias, directory, manifest }) => {
         if (sourceDir && manifest) {
             return textResponse("You can't specify both `sourceDir` and `manifest` parameters.", true);
         }

package/lib/tools/orgs/sf-list-all-orgs.js

@@ -41,7 +41,11 @@ Example usage:
 Can you list all Salesforce orgs for me
 List all Salesforce orgs
 List all orgs
-`, listAllOrgsParamsSchema.shape, async ({ directory }) => {
+`, listAllOrgsParamsSchema.shape, {
+        title: 'List All Orgs',
+        readOnlyHint: true,
+        openWorldHint: false,
+    }, async ({ directory }) => {
         try {
             process.chdir(directory);
             const orgs = await getAllAllowedOrgs();

package/lib/tools/testing/index.d.ts

@@ -1,2 +1,2 @@
-export * from './sf-run-apex-tests.js';
-export * from './sf-run-agent-tests.js';
+export * from './sf-test-apex.js';
+export * from './sf-test-agents.js';

package/lib/tools/testing/index.js

@@ -13,6 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from './sf-run-apex-tests.js';
-export * from './sf-run-agent-tests.js';
+export * from './sf-test-apex.js';
+export * from './sf-test-agents.js';
 //# sourceMappingURL=index.js.map

package/lib/tools/testing/{sf-run-agent-tests.js → sf-test-agents.js}

@@ -39,7 +39,7 @@ const runAgentTestsParam = z.object({
  * - textResponse: Test result.
  */
 export const registerToolRunAgentTest = (server) => {
-    server.tool('sf-run-agent-tests', `Run Agent tests in an org. 
+    server.tool('sf-test-agents', `Run Agent tests in an org.
 
 AGENT INSTRUCTIONS:
 If the user doesn't specify what to test, take context from the currently open file
@@ -50,7 +50,10 @@ this should be chosen when a file in the 'aiEvaluationDefinitions' directory is
 EXAMPLE USAGE:
 Run tests for the X agent
 Run this test
-`, runAgentTestsParam.shape, async ({ usernameOrAlias, agentApiName, directory }) => {
+`, runAgentTestsParam.shape, {
+        title: 'Run Agent Tests',
+        openWorldHint: false,
+    }, async ({ usernameOrAlias, agentApiName, directory }) => {
         if (!usernameOrAlias)
             return textResponse('The usernameOrAlias parameter is required, if the user did not specify one use the #sf-get-username tool', true);
         // needed for org allowlist to work
@@ -67,4 +70,4 @@ Run this test
         }
     });
 };
-//# sourceMappingURL=sf-run-agent-tests.js.map
+//# sourceMappingURL=sf-test-agents.js.map

package/lib/tools/testing/{sf-run-apex-tests.js → sf-test-apex.js}

@@ -30,7 +30,7 @@ RunSpecifiedTests="Run the Apex tests I specify, these will be specified in the
 `),
     classNames: z.array(z.string()).describe(`Apex tests classes to run.
             if Running all tests, all tests should be listed
-            if unsure, find apex classes matching the pattern *.cls, that include the @isTest decorator in the file and then join their test names together with ','
+            if unsure, find apex classes matching the pattern **/classes/*.cls, that include the @isTest decorator in the file and then join their test names together with ','
 `),
     usernameOrAlias: usernameOrAliasParam,
     directory: directoryParam,
@@ -48,7 +48,7 @@ RunSpecifiedTests="Run the Apex tests I specify, these will be specified in the
  * - textResponse: Test result.
  */
 export const registerToolRunApexTest = (server) => {
-    server.tool('sf-run-apex-tests', `Run Apex tests in an org. 
+    server.tool('sf-test-apex', `Run Apex tests in an org.
 
 AGENT INSTRUCTIONS:
 If the user doesn't specify what to test, take context from the currently open file
@@ -58,9 +58,12 @@ this should be chosen when a file in the 'classes' directory is mentioned
 
 EXAMPLE USAGE:
 Run tests A, B, C.
-Run the tests, find apex classes matching the pattern *.cls, that include the @isTest decorator in the file and then join their test names together with ','
+Run the tests, find apex classes matching the pattern **/classes/*.cls, that include the @isTest decorator in the file and then join their test names together with ','
 Run all tests in the org.
-`, runApexTestsParam.shape, async ({ testLevel, usernameOrAlias, classNames, directory }) => {
+`, runApexTestsParam.shape, {
+        title: 'Apex Tests',
+        openWorldHint: false,
+    }, async ({ testLevel, usernameOrAlias, classNames, directory }) => {
         if (testLevel !== "RunSpecifiedTests" /* TestLevel.RunSpecifiedTests */ && classNames?.length && classNames?.length >= 1) {
             return textResponse("You can't specify which tests to run without setting testLevel='RunSpecifiedTests'", true);
         }
@@ -80,4 +83,4 @@ Run all tests in the org.
         }
     });
 };
-//# sourceMappingURL=sf-run-apex-tests.js.map
+//# sourceMappingURL=sf-test-apex.js.map

package/lib/tools/users/sf-assign-permission-set.js

@@ -57,7 +57,10 @@ Set the permission set MyPermSet on behalf of my-alias.`),
     directory: directoryParam,
 });
 export const registerToolAssignPermissionSet = (server) => {
-    server.tool('sf-assign-permission-set', 'Assign a permission set to one or more org users.', assignPermissionSetParamsSchema.shape, async ({ permissionSetName, usernameOrAlias, onBehalfOf, directory }) => {
+    server.tool('sf-assign-permission-set', 'Assign a permission set to one or more org users.', assignPermissionSetParamsSchema.shape, {
+        title: 'Assign Permission Set',
+        openWorldHint: false,
+    }, async ({ permissionSetName, usernameOrAlias, onBehalfOf, directory }) => {
         try {
             if (!usernameOrAlias)
                 return textResponse('The usernameOrAlias parameter is required, if the user did not specify one use the #sf-get-username tool', true);