Skip to content

Commit f0dd441

Browse files
committed
added HOW TO Use instructions in README.md
1 parent 8d6b652 commit f0dd441

File tree

1 file changed

+110
-0
lines changed
  • packages/mcp-provider-scale-products

1 file changed

+110
-0
lines changed

packages/mcp-provider-scale-products/README.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,115 @@ This npm package is currently for internal use only. Its contents may change at
88

99
This package provides MCP tools for the Salesforce Scale Products suite — [ApexGuru](https://help.salesforce.com/s/articleView?id=xcloud.apexguru_overview.htm&type=5), [Scale Test](https://www.salesforce.com/in/platform/application-scaling-performance-testing/) and [Scale Center](https://help.salesforce.com/s/articleView?id=xcloud.scale_center_overview.htm&type=5). The tools help developers and architects identify performance bottlenecks, optimize Apex code, and ensure applications scale reliably under peak loads.
1010

11+
## How to Use This Toolset
12+
13+
### Agentforce Vibes
14+
15+
```json
16+
{
17+
"servers": {
18+
"salesforce-mcp": {
19+
"type": "stdio",
20+
"command": "npx",
21+
"args": [
22+
"@salesforce/mcp@latest",
23+
"--toolsets",
24+
"scale-products",
25+
"--orgs",
26+
"DEFAULT_TARGET_ORG"
27+
]
28+
}
29+
},
30+
"inputs": []
31+
}
32+
```
33+
34+
### VSCode
35+
36+
```json
37+
{
38+
"servers": {
39+
"salesforce-mcp": {
40+
"type": "stdio",
41+
"command": "npx",
42+
"args": [
43+
"@salesforce/mcp@latest",
44+
"--toolsets",
45+
"scale-products",
46+
"--orgs",
47+
"DEFAULT_TARGET_ORG"
48+
]
49+
}
50+
},
51+
"inputs": []
52+
}
53+
```
54+
55+
### Cline
56+
57+
```json
58+
{
59+
"mcpServers": {
60+
"Salesforce MCP": {
61+
"command": "npx",
62+
"args": [
63+
"@salesforce/mcp@latest",
64+
"--toolsets",
65+
"scale-products",
66+
"--orgs",
67+
"DEFAULT_TARGET_ORG"
68+
]
69+
}
70+
}
71+
}
72+
```
73+
74+
### Claude Code
75+
76+
**1. User Scope (Global)**
77+
78+
Recommended. This makes the Salesforce tools available across all your projects. It saves the configuration to your global `~/.claude.json` file.
79+
80+
```bash
81+
claude mcp add --scope user salesforce npx -- @salesforce/mcp@latest --toolsets scale-products --orgs DEFAULT_TARGET_ORG
82+
```
83+
84+
**2. Project Scope (Shared)**
85+
86+
Use this if you want the configuration to be checked into Git so that other team members can use the same server. It creates or updates a `.mcp.json` file in your current directory.
87+
88+
```bash
89+
claude mcp add --scope project salesforce npx -- @salesforce/mcp@latest --toolsets scale-products --orgs DEFAULT_TARGET_ORG
90+
```
91+
92+
> **Note:** Claude Code will prompt you for approval when you first enter a project folder containing a project-scoped server.
93+
94+
**3. Local Scope (Current Setup Only)**
95+
96+
This is the default scope if you don't provide a flag. It is similar to project scope but is typically used for personal experimental configurations that you don't necessarily want to share with the whole team via version control.
97+
98+
```bash
99+
claude mcp add --scope local salesforce npx -- @salesforce/mcp@latest --toolsets scale-products --orgs DEFAULT_TARGET_ORG
100+
```
101+
102+
### Cursor
103+
104+
```json
105+
{
106+
"mcpServers": {
107+
"Salesforce DX": {
108+
"command": "npx",
109+
"args": [
110+
"-y",
111+
"@salesforce/mcp@latest",
112+
"--orgs", "DEFAULT_TARGET_ORG",
113+
"--toolsets", "scale-products"
114+
]
115+
}
116+
}
117+
}
118+
```
119+
11120

12121
## Tools
13122

@@ -94,6 +203,7 @@ If your MCP client isn't calling the Scale tools you expect, try these tips:
94203

95204
> *Scan MyClass.cls for performance antipatterns using the `scan_apex_class_for_antipatterns` MCP tool.*
96205
206+
97207
## Development
98208

99209
Ensure you are in the monorepo root or the package directory.

0 commit comments

Comments
 (0)