@salesforce/mcp 0.23.5-dev.1 → 0.23.5

package/README.md

@@ -29,7 +29,7 @@ The Salesforce DX MCP Server is a specialized Model Context Protocol (MCP) imple
 
 ## Configure the DX MCP Server
 
-Configure the Salesforce DX MCP Server for your MCP client by updating its associated MCP JSON file; each client is slightly different, so check your MCP client documentation for details. 
+Configure the Salesforce DX MCP Server for your MCP client by updating its associated MCP JSON file; each client is slightly different, so check your MCP client documentation for details. See [MCP Client Configurations](./README.md#mcp-client-configurations) for more examples. 
 
 Here's an example for VS Code with Copilot in which you create and update a `.vscode/mcp.json` file in your project:
 
@@ -39,14 +39,15 @@ Here's an example for VS Code with Copilot in which you create and update a `.vs
        "Salesforce DX": {
          "command": "npx",
          "args": ["-y", "@salesforce/mcp", 
-         "--orgs", "DEFAULT_TARGET_ORG", 
-         "--toolsets", "orgs,metadata,data,users",
-         "--tools", "run_apex_test",
-         "--allow-non-ga-tools"]
+                 "--orgs", "DEFAULT_TARGET_ORG", 
+                 "--toolsets", "orgs,metadata,data,users",
+                 "--tools", "run_apex_test",
+                 "--allow-non-ga-tools"]
        }
      }
 }
 ```
+
 The `args` format shown in the preceding example is the same for all MCP clients; it's how you customize the DX MCP Server for your particular environment. Notes:
 
 - The `"-y", "@salesforce/mcp"` part tells `npx` to automatically install the `@salesforce/mcp` package instead of asking permission. Don't change this. 
@@ -54,17 +55,87 @@ The `args` format shown in the preceding example is the same for all MCP clients
 - When writing the `args` option, surround both the flag names and their values in double quotes, and separate all flags and values with commas. Some flags are Boolean and don't take a value.
 - The preceding example shows three flags that take a string value (`--orgs`, `--toolsets`, and `--tools`) and one Boolean flag (`--allow-non-ga-tools`).  This configuration starts a DX MCP Server that enables all the MCP tools in the `orgs`, `metadata`, `data`, and `users` toolsets and a specific tool called `run_apex_tests`.  It also enables tools in these configured toolsets that aren't yet generally available. 
 
+<details>
+<summary>Reference: MCP Client Configurations</summary>
+
+## MCP Client Configurations
+
+Here are examples of configuring the Salesforce DX MCP Server in various MCP clients. 
+
+### Claude Code
+
+To configure [Claude Code](https://www.claude.com/product/claude-code) to work with Salesforce DX MCP Server, add this snippet to the `.mcp.json` file in your project:
+```
+{
+  "mcpServers": {
+    "Salesforce DX": {
+      "command": "npx",
+      "args": ["-y", "@salesforce/mcp",
+               "--orgs", "DEFAULT_TARGET_ORG",
+               "--toolsets", "orgs,metadata,data,users",
+               "--tools", "run_apex_test",
+               "--allow-non-ga-tools" ]
+    }
+  }
+}
+```
+### Cursor
+
+To configure [Cursor](https://cursor.com/docs/context/mcp) to work with Salesforce DX MCP Server, add this snippet to your Cursor `mcp.json` file:
+
+```json
+{
+  "mcpServers": {
+    "Salesforce DX": {
+      "command": "npx",
+      "args": ["-y", "@salesforce/mcp@latest", 
+               "--orgs", "DEFAULT_TARGET_ORG",
+               "--toolsets", "orgs,metadata,data,users",
+               "--tools", "run_apex_test",
+               "--allow-non-ga-tools" ]
+    }
+  }
+}
+```
+
+### Cline
+
+To configure [Cline](https://docs.cline.bot/mcp/mcp-overview) to work with Salesforce DX MCP Server, add this snippet to your Cline `cline_mcp_settings.json` file:
+```json
+{
+  "mcpServers": {
+    "Salesforce DX": {
+      "command": "npx",
+      "args": ["-y", "@salesforce/mcp@latest", 
+               "--orgs", "DEFAULT_TARGET_ORG",
+               "--toolsets", "orgs,metadata,data,users",
+               "--tools", "run_apex_test",
+               "--allow-non-ga-tools" ]
+    }
+  }
+}
+```
+
+### Other MCP Clients
+
+For these other clients, refer to their documentation for adding MCP servers and follow the same pattern as in the preceding examples to configure the Salesforce DX MCP Server:
+
+- [Windsurf](https://docs.windsurf.com/windsurf/cascade/mcp)
+- [Zed](https://github.com/zed-industries/zed)
+- [Trae](https://docs.trae.ai/ide/model-context-protocol?_lang=en)
+
+</details>
 <details>
 <summary>Reference: Available Flags for the `args` Option</summary>
 
-## Reference: Available Flags for the "args" Option
+## Available Flags for the "args" Option
 
 These are the flags that you can pass to the `args` option. 
 
 | Flag Name | Description | Required? |Notes |
 | -----------------| -------| ------- | ----- |
-| `--orgs` | One or more orgs that you've locally authorized. | Yes | You must specify at least one org. <br/> <br/>See [Configure Orgs](README.md#configure-orgs) for the values you can pass to this flag. |
-| `--toolsets` | Sets of tools, based on functionality, that you want to enable. | No | Set to "all" to enable every tool in every toolset. <br/> <br/>See [Configure Toolsets](README.md#configure-toolsets) for the values you can pass to this flag.|
+| `--orgs` | One or more orgs that you've locally authorized. | Yes | You must specify at least one org. <br/> <br/>See [Configure Orgs](./README.md#configure-orgs) for the values you can pass to this flag. |
+| `--toolsets` | Sets of tools, based on functionality, that you want to enable. | No | Set to "all" to enable every tool in every toolset. <br/> <br/>See [Configure Toolsets](./README.md#configure-toolsets) for the values you can pass to this flag.|
 | `--tools` | Individual tool names that you want to enable. | No | You can use this flag in combination with the `--toolsets` flag. For example, you can enable all tools in one toolset, and just one tool in a different toolset. |
 | `--no-telemetry` | Boolean flag to disable telemetry, the automatic collection of data for monitoring and analysis. | No | Telemetry is enabled by default, so specify this flag to disable it.  |
 | `--debug` | Boolean flag that requests that the DX MCP Server print debug logs. | No | Debug mode is disabled by default. <br/> <br/>**NOTE:** Not all MCP clients expose MCP logs, so this flag might not work for all IDEs. |
@@ -211,7 +282,7 @@ Orchestrates the complete Aura to LWC migration workflow. Provides end-to-end gu
  - `guide_lwc_best_practices` - (GA) Offers LWC development best practices and coding standards guidance
  - `guide_lwc_development` - (GA) Comprehensive LWC development workflow and implementation guidelines
  - `guide_lwc_rtl_support` - (GA) Right-to-Left internationalization support and RTL development guidance
- - `guide_lwc_slds2_uplift_linter_fixes` - (GA) Analyzes the given LWC code along with the slds-linter output to fix issues using the SLDS2 knowledge
+ - `guide_lwc_slds2_uplift_linter_fixes` - (NON-GA) Analyzes the given LWC code along with the slds-linter output to fix issues using the SLDS2 knowledge
  - `guide_lwc_security` - (GA) Comprehensive security analysis in accordance with Product Security Guidelines and Lightning Web Security Guidelines
  - `guide_design_general` - (GA) Comprehensive SLDS guidelines and best practices for Lightning Web Components with accessibility, responsive design, and component usage patterns
 
@@ -220,7 +291,7 @@ Orchestrates the complete Aura to LWC migration workflow. Provides end-to-end gu
  - `orchestrate_lwc_component_creation` - (GA) Step-by-step component creation workflow guidance
  - `orchestrate_lwc_component_optimization` - (GA)  Performance optimization and best practices for LWC components
  - `orchestrate_lwc_component_testing` - (GA) Comprehensive testing workflow and test generation guidance
- - `orchestrate_lwc_slds2_uplift` - (GA) Migration guidance for upgrading to SLDS2 design system
+ - `orchestrate_lwc_slds2_uplift` - (NON-GA) Migration guidance for upgrading to SLDS2 design system
 
 #### LDS (Lightning Data Service) Tools