Skip to content

Commit 8e3e7c2

Browse files
W-19586093: onboard Mobile-Web-MCP-Server (#208)
* feat: onboard mobile mcp provider * feat: add two tools for mobile-web-mcp-server * feat: add nativeCapabilityTool in mobile-web-mcp-server * fix: refactor the mobile-web mcp server structure * fix: update readme * chore: refactor the tool name * chore: add copyright * fix: apply the review * feat: add mobile toolset type * feat: add 'mobile-lite' toolset type * fix: apply the review feedback * fix: if one tool has more than 1 toolset type, the registration fails when all toolset type are allowed * feat: add publish workflow * fix: remove the 'semver' dev dependency
1 parent 38df6fe commit 8e3e7c2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+4443
-60
lines changed

.github/workflows/publish-providers.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ on:
77
paths:
88
- 'packages/mcp-provider-api/**'
99
- 'packages/mcp-provider-dx-core/**'
10+
- 'packages/mcp-provider-mobile-web/**'
1011
# - 'packages/mcp-provider-code-analyzer/**'
1112
workflow_dispatch:
1213
inputs:
@@ -34,10 +35,10 @@ jobs:
3435
id: detect
3536
run: |
3637
# Packages that auto-publish on push to main
37-
AUTO_PUBLISHABLE_PACKAGES=("mcp-provider-api" "mcp-provider-dx-core")
38+
AUTO_PUBLISHABLE_PACKAGES=("mcp-provider-api" "mcp-provider-dx-core" "mcp-provider-mobile-web")
3839
3940
# All available provider packages
40-
ALL_PACKAGES=("mcp-provider-api" "mcp-provider-dx-core" "mcp-provider-code-analyzer")
41+
ALL_PACKAGES=("mcp-provider-api" "mcp-provider-dx-core" "mcp-provider-code-analyzer" "mcp-provider-mobile-web")
4142
4243
# Initialize packages array
4344
PACKAGES='[]'

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,8 @@ These are the available toolsets.
200200
| `metadata` | [Tools to deploy and retrieve metadata to and from your org and your DX project.](README.md#metadata-toolset)|
201201
| `testing` | [Tools to test your code and features](README.md#testing-toolset)|
202202
| `other` | [Other useful tools, such as tools for static analysis of your code using Salesforce Code Analyzer.](README.md#other-toolset)|
203+
| `mobile` | [Tools for mobile development and capabilities.](README.md#mobile-toolset)|
204+
| `mobile-core` | [A subset of mobile tools focused on essential mobile capabilities.](README.md#mobile-core-toolset)|
203205

204206
This example shows how to enable the `data`, `orgs`, `metadata`, and `other` toolsets when configuring the MCP server for VS Code:
205207

@@ -258,13 +260,46 @@ Includes these tools:
258260
- `sf-test-agents` - Executes agent tests in your org.
259261
- `sf-test-apex` - Executes apex tests in your org.
260262

263+
#### Mobile Toolset
264+
265+
Includes these tools, which aren't yet generally available:
266+
267+
- `sf-mobile-web-app-review` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC App Review Service, offering expert guidance for implementing app review features in Lightning Web Components.
268+
- `sf-mobile-web-ar-space-capture` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC AR Space Capture, offering expert guidance for implementing AR space capture features in Lightning Web Components.
269+
- `sf-mobile-web-barcode-scanner` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Barcode Scanner, offering expert guidance for implementing barcode scanning features in Lightning Web Components.
270+
- `sf-mobile-web-biometrics` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Biometrics Service, offering expert guidance for implementing biometric authentication features in Lightning Web Components.
271+
- `sf-mobile-web-calendar` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Calendar Service, offering expert guidance for implementing calendar integration features in Lightning Web Components.
272+
- `sf-mobile-web-contacts` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Contacts Service, offering expert guidance for implementing contacts management features in Lightning Web Components.
273+
- `sf-mobile-web-document-scanner` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Document Scanner, offering expert guidance for implementing document scanning features in Lightning Web Components.
274+
- `sf-mobile-web-geofencing` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Geofencing Service, offering expert guidance for implementing geofencing features in Lightning Web Components.
275+
- `sf-mobile-web-location` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Location Service, offering expert guidance for implementing location services in Lightning Web Components.
276+
- `sf-mobile-web-nfc` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC NFC Service, offering expert guidance for implementing NFC features in Lightning Web Components.
277+
- `sf-mobile-web-payments` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Payments Service, offering expert guidance for implementing payment processing features in Lightning Web Components.
278+
- `sf-mobile-web-offline-analysis` - (NON-GA) Analyzes Lightning Web Components for mobile-specific issues and provides detailed recommendations for mobile offline compatibility and performance improvements.
279+
- `sf-mobile-web-offline-guidance` - (NON-GA) Provides structured review instructions to detect and remediate mobile offline code violations in Lightning Web Components for Salesforce Mobile Apps.
280+
281+
**NOTE:** The tools marked NON-GA are not yet generally available, specify the `--allow-non-ga-tools` flag to use them.
282+
283+
#### Mobile-core Toolset
284+
285+
Includes these essential mobile tools, which aren't yet generally available:
286+
287+
- `sf-mobile-web-barcode-scanner` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Barcode Scanner, offering expert guidance for implementing barcode scanning features in Lightning Web Components.
288+
- `sf-mobile-web-biometrics` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Biometrics Service, offering expert guidance for implementing biometric authentication features in Lightning Web Components.
289+
- `sf-mobile-web-location` - (NON-GA) Provides TypeScript API documentation for Salesforce LWC Location Service, offering expert guidance for implementing location services in Lightning Web Components.
290+
- `sf-mobile-web-offline-analysis` - (NON-GA) Analyzes Lightning Web Components for mobile-specific issues and provides detailed recommendations for mobile offline compatibility and performance improvements.
291+
- `sf-mobile-web-offline-guidance` - (NON-GA) Provides structured review instructions to detect and remediate mobile offline code violations in Lightning Web Components for Salesforce Mobile Apps.
292+
293+
**NOTE:** The tools marked NON-GA are not yet generally available, specify the `--allow-non-ga-tools` flag to use them.
294+
261295
#### Other Toolset
262296

263297
Includes these tools, which aren't yet generally available:
264298

265299
- `sf-code-analyzer-run` - (NON-GA) Performs a static analysis of your code using Salesforce Code Analyzer. Includes validating that the code conforms to best practices, checking for security vulnerabilities, and identifying possible performance issues.
266300
- `sf-code-analyzer-describe-rule` - (NON-GA) Gets the description of a Salesforce Code Analyzer rule, including the engine it belongs to, its severity, and associated tags.
267301

302+
268303
**NOTE:** The tools marked NON-GA are not yet generally available, specify the `--allow-non-ga-tools` flag to use them.
269304

270305
## Configure Other Clients to Use the Salesforce DX MCP Server

packages/mcp-provider-api/src/enums.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ export enum Toolset {
1717
METADATA = 'metadata',
1818
TESTING = 'testing',
1919
USERS = 'users',
20+
MOBILE = 'mobile',
21+
MOBILE_CORE = 'mobile-core',
2022
OTHER = 'other'
2123
}
2224

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
**/resources/*
2+
/docs
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"@salesforce/prettier-config"
Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
Apache License Version 2.0
2+
3+
Copyright (c) 2025 Salesforce, Inc.
4+
All rights reserved.
5+
6+
Apache License
7+
Version 2.0, January 2004
8+
http://www.apache.org/licenses/
9+
10+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11+
12+
1. Definitions.
13+
14+
"License" shall mean the terms and conditions for use, reproduction,
15+
and distribution as defined by Sections 1 through 9 of this document.
16+
17+
"Licensor" shall mean the copyright owner or entity authorized by
18+
the copyright owner that is granting the License.
19+
20+
"Legal Entity" shall mean the union of the acting entity and all
21+
other entities that control, are controlled by, or are under common
22+
control with that entity. For the purposes of this definition,
23+
"control" means (i) the power, direct or indirect, to cause the
24+
direction or management of such entity, whether by contract or
25+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
26+
outstanding shares, or (iii) beneficial ownership of such entity.
27+
28+
"You" (or "Your") shall mean an individual or Legal Entity
29+
exercising permissions granted by this License.
30+
31+
"Source" form shall mean the preferred form for making modifications,
32+
including but not limited to software source code, documentation
33+
source, and configuration files.
34+
35+
"Object" form shall mean any form resulting from mechanical
36+
transformation or translation of a Source form, including but
37+
not limited to compiled object code, generated documentation,
38+
and conversions to other media types.
39+
40+
"Work" shall mean the work of authorship, whether in Source or
41+
Object form, made available under the License, as indicated by a
42+
copyright notice that is included in or attached to the work
43+
(an example is provided in the Appendix below).
44+
45+
"Derivative Works" shall mean any work, whether in Source or Object
46+
form, that is based on (or derived from) the Work and for which the
47+
editorial revisions, annotations, elaborations, or other modifications
48+
represent, as a whole, an original work of authorship. For the purposes
49+
of this License, Derivative Works shall not include works that remain
50+
separable from, or merely link (or bind by name) to the interfaces of,
51+
the Work and Derivative Works thereof.
52+
53+
"Contribution" shall mean any work of authorship, including
54+
the original version of the Work and any modifications or additions
55+
to that Work or Derivative Works thereof, that is intentionally
56+
submitted to Licensor for inclusion in the Work by the copyright owner
57+
or by an individual or Legal Entity authorized to submit on behalf of
58+
the copyright owner. For the purposes of this definition, "submitted"
59+
means any form of electronic, verbal, or written communication sent
60+
to the Licensor or its representatives, including but not limited to
61+
communication on electronic mailing lists, source code control systems,
62+
and issue tracking systems that are managed by, or on behalf of, the
63+
Licensor for the purpose of discussing and improving the Work, but
64+
excluding communication that is conspicuously marked or otherwise
65+
designated in writing by the copyright owner as "Not a Contribution."
66+
67+
"Contributor" shall mean Licensor and any individual or Legal Entity
68+
on behalf of whom a Contribution has been received by Licensor and
69+
subsequently incorporated within the Work.
70+
71+
2. Grant of Copyright License. Subject to the terms and conditions of
72+
this License, each Contributor hereby grants to You a perpetual,
73+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74+
copyright license to reproduce, prepare Derivative Works of,
75+
publicly display, publicly perform, sublicense, and distribute the
76+
Work and such Derivative Works in Source or Object form.
77+
78+
3. Grant of Patent License. Subject to the terms and conditions of
79+
this License, each Contributor hereby grants to You a perpetual,
80+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81+
(except as stated in this section) patent license to make, have made,
82+
use, offer to sell, sell, import, and otherwise transfer the Work,
83+
where such license applies only to those patent claims licensable
84+
by such Contributor that are necessarily infringed by their
85+
Contribution(s) alone or by combination of their Contribution(s)
86+
with the Work to which such Contribution(s) was submitted. If You
87+
institute patent litigation against any entity (including a
88+
cross-claim or counterclaim in a lawsuit) alleging that the Work
89+
or a Contribution incorporated within the Work constitutes direct
90+
or contributory patent infringement, then any patent licenses
91+
granted to You under this License for that Work shall terminate
92+
as of the date such litigation is filed.
93+
94+
4. Redistribution. You may reproduce and distribute copies of the
95+
Work or Derivative Works thereof in any medium, with or without
96+
modifications, and in Source or Object form, provided that You
97+
meet the following conditions:
98+
99+
(a) You must give any other recipients of the Work or
100+
Derivative Works a copy of this License; and
101+
102+
(b) You must cause any modified files to carry prominent notices
103+
stating that You changed the files; and
104+
105+
(c) You must retain, in the Source form of any Derivative Works
106+
that You distribute, all copyright, patent, trademark, and
107+
attribution notices from the Source form of the Work,
108+
excluding those notices that do not pertain to any part of
109+
the Derivative Works; and
110+
111+
(d) If the Work includes a "NOTICE" text file as part of its
112+
distribution, then any Derivative Works that You distribute must
113+
include a readable copy of the attribution notices contained
114+
within such NOTICE file, excluding those notices that do not
115+
pertain to any part of the Derivative Works, in at least one
116+
of the following places: within a NOTICE text file distributed
117+
as part of the Derivative Works; within the Source form or
118+
documentation, if provided along with the Derivative Works; or,
119+
within a display generated by the Derivative Works, if and
120+
wherever such third-party notices normally appear. The contents
121+
of the NOTICE file are for informational purposes only and
122+
do not modify the License. You may add Your own attribution
123+
notices within Derivative Works that You distribute, alongside
124+
or as an addendum to the NOTICE text from the Work, provided
125+
that such additional attribution notices cannot be construed
126+
as modifying the License.
127+
128+
You may add Your own copyright statement to Your modifications and
129+
may provide additional or different license terms and conditions
130+
for use, reproduction, or distribution of Your modifications, or
131+
for any such Derivative Works as a whole, provided Your use,
132+
reproduction, and distribution of the Work otherwise complies with
133+
the conditions stated in this License.
134+
135+
5. Submission of Contributions. Unless You explicitly state otherwise,
136+
any Contribution intentionally submitted for inclusion in the Work
137+
by You to the Licensor shall be under the terms and conditions of
138+
this License, without any additional terms or conditions.
139+
Notwithstanding the above, nothing herein shall supersede or modify
140+
the terms of any separate license agreement you may have executed
141+
with Licensor regarding such Contributions.
142+
143+
6. Trademarks. This License does not grant permission to use the trade
144+
names, trademarks, service marks, or product names of the Licensor,
145+
except as required for reasonable and customary use in describing the
146+
origin of the Work and reproducing the content of the NOTICE file.
147+
148+
7. Disclaimer of Warranty. Unless required by applicable law or
149+
agreed to in writing, Licensor provides the Work (and each
150+
Contributor provides its Contributions) on an "AS IS" BASIS,
151+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152+
implied, including, without limitation, any warranties or conditions
153+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154+
PARTICULAR PURPOSE. You are solely responsible for determining the
155+
appropriateness of using or redistributing the Work and assume any
156+
risks associated with Your exercise of permissions under this License.
157+
158+
8. Limitation of Liability. In no event and under no legal theory,
159+
whether in tort (including negligence), contract, or otherwise,
160+
unless required by applicable law (such as deliberate and grossly
161+
negligent acts) or agreed to in writing, shall any Contributor be
162+
liable to You for damages, including any direct, indirect, special,
163+
incidental, or consequential damages of any character arising as a
164+
result of this License or out of the use or inability to use the
165+
Work (including but not limited to damages for loss of goodwill,
166+
work stoppage, computer failure or malfunction, or any and all
167+
other commercial damages or losses), even if such Contributor
168+
has been advised of the possibility of such damages.
169+
170+
9. Accepting Warranty or Additional Liability. While redistributing
171+
the Work or Derivative Works thereof, You may choose to offer,
172+
and charge a fee for, acceptance of support, warranty, indemnity,
173+
or other liability obligations and/or rights consistent with this
174+
License. However, in accepting such obligations, You may act only
175+
on Your own behalf and on Your sole responsibility, not on behalf
176+
of any other Contributor, and only if You agree to indemnify,
177+
defend, and hold each Contributor harmless for any liability
178+
incurred by, or claims asserted against, such Contributor by reason
179+
of your accepting any such warranty or additional liability.
180+
181+
END OF TERMS AND CONDITIONS
182+
183+
APPENDIX: How to apply the Apache License to your work.
184+
185+
To apply the Apache License to your work, attach the following
186+
boilerplate notice, with the fields enclosed by brackets "{}"
187+
replaced with your own identifying information. (Don't include
188+
the brackets!) The text should be enclosed in the appropriate
189+
comment syntax for the file format. We also recommend that a
190+
file or class name and description of purpose be included on the
191+
same "printed page" as the copyright notice for easier
192+
identification within third-party archives.
193+
194+
Copyright {yyyy} {name of copyright owner}
195+
196+
Licensed under the Apache License, Version 2.0 (the "License");
197+
you may not use this file except in compliance with the License.
198+
You may obtain a copy of the License at
199+
200+
http://www.apache.org/licenses/LICENSE-2.0
201+
202+
Unless required by applicable law or agreed to in writing, software
203+
distributed under the License is distributed on an "AS IS" BASIS,
204+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205+
See the License for the specific language governing permissions and
206+
limitations under the License.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# For Internal Use Only
2+
3+
This npm package is currently for internal use only. Its contents may change at any time with no gaurantee of compatibility with prior versions.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import eslint from "@eslint/js";
2+
import tseslint from "typescript-eslint";
3+
4+
export default tseslint.config(
5+
eslint.configs.recommended,
6+
...tseslint.configs.recommended,
7+
{
8+
ignores: ["dist/**/*", "coverage/**/*", "node_modules/**/*"],
9+
},
10+
{
11+
rules: {
12+
"@typescript-eslint/no-unused-vars": [
13+
"error",
14+
{
15+
argsIgnorePattern: "^_",
16+
varsIgnorePattern: "^_",
17+
caughtErrorsIgnorePattern: "^_",
18+
},
19+
],
20+
},
21+
}
22+
);

0 commit comments

Comments
 (0)