@salesforce/mcp-provider-lwc-experts 0.1.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+Terms of Use
+
+Copyright 2025 Salesforce, Inc. All rights reserved. 
+
+These Terms of Use govern the download, installation, and/or use of this software provided by Salesforce, Inc. (“Salesforce”) (the “Software”), were last updated on April 15, 2022, and constitute a legally binding agreement between you and Salesforce. If you do not agree to these Terms of Use, do not install or use the Software. The Software may link to third-party software components licensed under various open source licenses (“Open Source Components”). These Terms of Use pertain solely to Salesforce's proprietary code in the Software. It does not alter or extend any rights or obligations regarding the Open Source Components. For clarity, your use of the Open Source Components is governed by the terms of the applicable open source license(s). You are solely responsible for complying with the terms and conditions of those open source licenses.
+ 
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute the Software and derivative works subject to these Terms. These Terms shall be included in all copies or substantial portions of the Software. 
+
+Subject to the limited rights expressly granted hereunder, Salesforce reserves all rights, title, and interest in and to all intellectual property subsisting in the Software. No rights are granted to you hereunder other than as expressly set forth herein. Users residing in countries on the United States Office of Foreign Assets Control sanction list, or which are otherwise subject to a US export embargo, may not use the Software.
+ 
+Implementation of the Software may require development work, for which you are responsible. The Software may contain bugs, errors and incompatibilities and is made available on an AS IS basis without support, updates, or service level commitments. 
+ 
+Salesforce reserves the right at any time to modify, suspend, or discontinue, the Software (or any part thereof) with or without notice. You agree that Salesforce shall not be liable to you or to any third party for any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or proceeding made or brought against Salesforce by a third party arising out of or accruing from (a) your use of the Software, and (b) any application you develop with the Software that infringes any copyright, trademark, trade secret, trade dress, patent, or other intellectual property right of any person or defames any person or violates their rights of publicity or privacy (each a “Claim Against Salesforce”), and will indemnify Salesforce from any damages, attorney fees, and costs finally awarded against Salesforce as a result of, or for any amounts paid by Salesforce under a settlement approved by you in writing of, a Claim Against Salesforce, provided Salesforce (x) promptly gives you written notice of the Claim Against Salesforce, (y) gives you sole control of the defense and settlement of the Claim Against Salesforce (except that you may not settle any Claim Against Salesforce unless it unconditionally releases Salesforce of all liability), and (z) gives you all reasonable assistance, at your expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT SUPPORTED AND IS PROVIDED “AS IS,” WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA, OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ 
+These Terms of Use shall be governed exclusively by the internal laws of the State of California, without regard to its conflicts of laws rules. Each party hereby consents to the exclusive jurisdiction of the state and federal courts located in San Francisco County, California to adjudicate any dispute arising out of or relating to these Terms of Use and the download, installation, and/or use of the Software. Except as expressly stated herein, these Terms of Use constitute the entire agreement between the parties, and supersede all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning their subject matter. No modification, amendment, or waiver of any provision of these Terms of Use shall be effective unless it is by an update to these Terms of Use that Salesforce makes available, or is in writing and signed by the party against whom the modification, amendment, or waiver is to be asserted.
+
+Data Privacy: Salesforce may collect, process, and store device, system, and other information related to your use of the Software. This information includes, but is not limited to, IP address, user metrics, and other data (“Usage Data”). Salesforce may use Usage Data for analytics, product development, and marketing purposes. You acknowledge that files generated in conjunction with the Software may contain sensitive or confidential data, and you are solely responsible for anonymizing and protecting such data.  

package/README.md

@@ -0,0 +1,82 @@
+# @salesforce/mcp-provider-lwc-experts
+
+A comprehensive collection of Model Context Protocol (MCP) tools for Lightning Web Component (LWC) development, analysis, and improvement. This package provides AI-powered tools accessible through MCP-compatible clients to analyze, review, and enhance LWC code for accessibility, performance, security, and best practices.
+
+## Features
+
+### LWC Development Tools
+
+- **Component Creation**: Step-by-step guidance for creating LWC components
+- **Component Optimization**: Performance optimization workflows and best practices
+- **Component Testing**: Jest test generation and testing workflows
+- **Best Practices**: Modern LWC development standards and patterns
+
+### Accessibility & Design System Tools
+
+- **Accessibility Analysis**: WCAG 2.2 compliance and accessibility testing
+- **SLDS2 Uplift**: Salesforce Lightning Design System v2 migration tools
+- **RTL Support**: Right-to-left language internationalization guidance
+- **Design System Compliance**: SLDS component usage and token-based styling
+
+### Data & API Analysis Tools
+
+- **LDS Framework Analysis**: Lightning Data Service patterns and consistency
+- **Component API Analysis**: LWC component API surface analysis
+- **Library API Analysis**: LWC library API exploration
+- **Namespace Exploration**: LWC module discovery and analysis
+
+### Security & Quality Tools
+
+- **Security Review**: Vulnerability analysis and security best practices
+- **Jest Test Review**: Test quality analysis and enhancement
+- **Migration Tools**: Aura to LWC migration completeness analysis
+- **Figma Integration**: Design-to-code conversion guidance
+
+## Installation
+
+```bash
+npm install @salesforce/mcp-provider-lwc-experts
+```
+
+## Usage
+
+This package provides MCP tools that can be used with any MCP-compatible client. The tools are organized into two categories:
+
+### Instruction-Only Tools
+
+Static guidance tools that provide best practices and workflows without requiring LLM API access:
+
+- `LWC_Guide_Development` - Core development guidelines
+- `LWC_Guide_BestPractices` - Modern LWC standards and patterns
+- `LWC_Create_Component` - Component creation instructions
+- `LWC_Workflow_Component_Creation` - End-to-end component creation workflow
+- `LWC_Workflow_Component_Optimization` - Performance optimization guidance
+- `LWC_Workflow_Component_Testing` - Complete testing workflow
+- `Figma_Guide_LWC_Conversion` - Design conversion guidance
+- `LWC_Guide_Accessibility` - Accessibility guidelines
+- `LDS_Guide_Development` - Lightning Design System guidelines
+- `LDS_Guide_Data_Consistency` - Data consistency patterns
+- `LWC_Guide_RTL` - RTL internationalization guidelines
+- `LDS_Guide_Referential_Integrity` - Referential integrity patterns
+- `LDS_Explore_UIAPI` - LDS UIAPI Directory knowledge
+- `Aura_Migration_Completeness` - Aura to LWC migration guidelines
+- `LWC_Analyze_Component_API` - Component API analysis
+- `LWC_Analyze_Library_API` - Library API analysis
+- `LWC_Explore_Namespace` - Namespace module exploration
+- `LWC_Guide_Component_Selection` - Component selection recommendations
+- `LWC_Generate_Jest_Tests` - Jest test generation guidance
+- `LWC_Review_Jest_Tests` - Test review and enhancement
+- `LWC_Run_Accessibility_Jest_Tests` - Accessibility testing instructions
+- `LWC_Workflow_SLDS2_Uplift` - SLDS2 migration workflow
+- `LWC_Guide_SLDS2_Uplift_Linter_Fixes` - SLDS2 linter fixes
+- `LWC_Guide_UpliftAiMetadata` - AI metadata enhancement
+
+### LLM-Powered Tools
+
+Dynamic analysis tools that require LLM API access for intelligent code analysis:
+
+- `LWC_Review_Security` - Security vulnerability analysis
+
+## MCP Integration
+
+To use these tools with an MCP client, configure your MCP client to connect to this package. The tools will be available for use in your AI assistant workflows.

package/agents/lds/resources/lwc/guides/reference/reference-create-list-info.md

@@ -0,0 +1,53 @@
+# `createListInfo`
+
+Creates a list view for a supported object.
+
+## Syntax
+
+```js
+import { createListInfo } from 'lightning/uiListsApi';
+
+createListInfo({ objectApiName: 'Account', listViewApiName: 'MyAccountListView' });
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) – API name of a supported object.
+- **`listViewApiName`** (String, Required) – API name of a list view (e.g., `"AllAccounts"`).
+- **`displayColumns`** (String[]) – Field API names displayed in the list.
+- **`filterLogicString`** (String) – Filter logic (e.g., `"(1 OR 2) and 3"`).
+- **`filteredByInfo`** (Object) – Filtering details
+- **`label`** (String) – Display label for the list.
+- **`listShares`** (String[]) – Objects shared with if `visibility = "Shared"`.
+- **`scope`** (Object) – Scope details
+- **`visibility`** (String) – One of `"Private"`, `"Public"`, or `"Shared"`.
+
+## Returns
+
+- **`data`** – List Info
+- **`error`** – FetchResponse.
+
+## Usage
+
+Creates a list view when the button is clicked.
+
+### JavaScript
+
+```js
+import { createListInfo } from 'lightning/uiListsApi';
+import { LightningElement } from 'lwc';
+
+export default class CreateListInfo extends LightningElement {
+  error;
+  displayColumns;
+
+  async createListView() {
+    createListInfo({
+      objectApiName: 'Account',
+      listViewApiName: 'AllAccounts',
+    })
+      .then(({ data }) => (this.displayColumns = data.displayColumns))
+      .catch(({ body }) => (this.error = body.message));
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/reference-create-record.md

@@ -0,0 +1,52 @@
+# `createRecord(recordInput)`
+
+Creates a record.
+
+## Syntax
+
+```js
+import { createRecord } from 'lightning/uiRecordApi';
+createRecord(recordInput: Record): Promise<Record>;
+```
+
+## Parameters
+
+- **`recordInput`** (Object, Required) – A RecordInput object used to create the record.
+
+### `recordInput` Properties
+
+- **`apiName`** (String, Required) – API name of a supported object.
+- **`fields`** (Object) – Map of field names to field values.
+
+## Returns
+
+A Promise that resolves with the created record, containing data for the fields in the record layout.
+
+## Usage
+
+Use `createRecord` by passing in a `recordInput` object with `apiName` and `fields` properties.
+
+```js
+import { createRecord } from 'lightning/uiRecordApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+import NAME_FIELD from '@salesforce/schema/Account.Name';
+
+export default class CreateRecordExample extends LightningElement {
+  name;
+
+  handleInput(event) {
+    this.name = event.target.value;
+  }
+
+  async handleCreate() {
+    const fields = { [NAME_FIELD.fieldApiName]: this.name };
+    const recordInput = { apiName: ACCOUNT_OBJECT.objectApiName, fields };
+
+    try {
+      const account = await createRecord(recordInput);
+    } catch (error) {
+      // Handle error
+    }
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/reference-delete-list-info.md

@@ -0,0 +1,56 @@
+# `deleteListInfo`
+
+Use this function to delete a list view.
+
+## Syntax
+
+```js
+import { deleteListInfo } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+deleteListInfo({ objectApiName: ACCOUNT_OBJECT, listViewApiName: 'MyAccountListView' });
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) - The API name of a supported object.
+- **`listViewApiName`** (String, Required) - The API name of a list view, such as `"AllAccounts"`.
+
+## Returns
+
+If a list view is deleted successfully, there is no response.  
+In case of an error, it returns:
+
+- **`error`** – FetchResponse
+
+## Usage
+
+This example deletes a list view when the button is clicked.
+
+### **JavaScript**
+
+```js
+import { deleteListInfo } from 'lightning/uiListsApi';
+import { LightningElement, api } from 'lwc';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class DeleteListInfo extends LightningElement {
+  errorMessage;
+  deleted;
+
+  @api async deleteListView() {
+    deleteListInfo({
+      objectApiName: ACCOUNT_OBJECT.objectApiName,
+      listViewApiName: 'AllAccounts_deleteListInfoTest',
+    })
+      .then(() => {
+        this.deleted = true;
+        this.errorMessage = undefined;
+      })
+      .catch((error) => {
+        this.errorMessage = error.body.message;
+        this.deleted = undefined;
+      });
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/reference-delete-record.md

@@ -0,0 +1,78 @@
+# `deleteRecord(recordId)`
+
+Deletes a record.
+
+## Syntax
+
+```js
+import { deleteRecord } from 'lightning/uiRecordApi';
+deleteRecord(recordId: string): Promise<void>;
+```
+
+## Parameters
+
+- **`recordId`** (String, Required) – The ID of the record to delete.
+
+## Returns
+
+A `Promise<void>` that resolves when the record is deleted.
+
+## Usage
+
+`deleteRecord` accepts a single record ID. To delete multiple records, use `Promise.all()` or Apex.
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { ShowToastEvent } from 'lightning/platformShowToastEvent';
+import { refreshApex } from '@salesforce/apex';
+import { deleteRecord } from 'lightning/uiRecordApi';
+import getAccountList from '@salesforce/apex/AccountController.getAccountList';
+import { reduceErrors } from 'c/ldsUtils';
+
+export default class LdsDeleteRecord extends LightningElement {
+  accounts;
+  error;
+  wiredAccountsResult;
+
+  @wire(getAccountList)
+  wiredAccounts(result) {
+    this.wiredAccountsResult = result;
+    if (result.data) {
+      this.accounts = result.data;
+      this.error = undefined;
+    } else if (result.error) {
+      this.error = result.error;
+      this.accounts = undefined;
+    }
+  }
+
+  async deleteAccount(event) {
+    const recordId = event.target.dataset.recordid;
+
+    try {
+      await deleteRecord(recordId);
+      this.dispatchEvent(
+        new ShowToastEvent({
+          title: 'Success',
+          message: 'Account deleted',
+          variant: 'success',
+        }),
+      );
+      await refreshApex(this.wiredAccountsResult);
+    } catch (error) {
+      this.dispatchEvent(
+        new ShowToastEvent({
+          title: 'Error deleting record',
+          message: reduceErrors(error).join(', '),
+          variant: 'error',
+        }),
+      );
+    }
+  }
+}
+```
+
+### Notes
+
+- If a component is subscribed to the deleted record via a wire, it will receive a 404 error after deletion.
+- Avoid calling `deleteRecord` from a record page for a record you want to delete, as it will result in a 404 error stating "The requested resource does not exist".

package/agents/lds/resources/lwc/guides/reference/reference-get-list-info-by-name.md

@@ -0,0 +1,60 @@
+# `getListInfoByName`
+
+Use this wire adapter to get the metadata for a list view.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListInfoByName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class Example extends LightningElement {
+  @wire(getListInfoByName, {
+    objectApiName: ACCOUNT_OBJECT,
+    listViewApiName: 'AllAccounts',
+  })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) - The API name of a supported object.
+- **`listViewApiName`** (String, Required) - The API name of a list view, such as `"AllAccounts"`.
+
+## Returns
+
+- **`data`** – List Info
+- **`error`** – FetchResponse
+
+## Usage
+
+This example fetches the List Info by API name, then iterates through the list of display columns in the List Info.
+
+### **JavaScript**
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListInfoByName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class WireListInfoByName extends LightningElement {
+  error;
+  displayColumns;
+
+  @wire(getListInfoByName, {
+    objectApiName: ACCOUNT_OBJECT.objectApiName,
+    listViewApiName: 'AllAccounts',
+  })
+  listInfo({ error, data }) {
+    if (data) {
+      this.displayColumns = data.displayColumns;
+      this.error = undefined;
+    } else if (error) {
+      this.error = error;
+      this.displayColumns = undefined;
+    }
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/reference-get-list-infos-by-name.md

@@ -0,0 +1,55 @@
+# `getListInfosByName`
+
+Use this wire adapter to get the metadata for a batch of list views.
+
+## Syntax
+
+```js
+import { getListInfosByName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class KeywordResults extends LightningElement {
+  @wire(getListInfosByName, {
+    names: ['Account.AllAccounts'],
+  })
+  getListInfosByNameWire({ data }) {
+    if (data && data.results) {
+      this.listInfos = data.results.map(({ result }) => result);
+    }
+  }
+}
+```
+
+## Parameters
+
+- **`names`** (String[], Required) - An array of comma-separated strings of list view names. A list view name starts with an entity name, a dot, and then the name of the list view, like `"Account.AllAccounts"`.
+
+## Returns
+
+- A **`results`** object with Simplified Batch Results and status codes.
+- **`error`** – FetchResponse
+
+## Usage
+
+This example fetches the list information by API name, then iterates through the list of display columns in the list information.
+
+### **JavaScript**
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListInfosByName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class WireListInfosByName extends LightningElement {
+  listInfos;
+
+  @wire(getListInfosByName, {
+    names: ['${ACCOUNT_OBJECT.objectApiName}.AllAccounts'],
+  })
+  listInfo({ error, data }) {
+    if (data) {
+      this.listInfos = data.results.map(({ result }) => result);
+    }
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/reference-get-list-infos-by-object-name.md

@@ -0,0 +1,64 @@
+# `getListInfosByObjectName`
+
+Use this wire to get the list views associated with a supported object.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListInfosByObjectName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class Example extends LightningElement {
+  @wire(getListInfosByObjectName, {
+    objectApiName: ACCOUNT_OBJECT,
+    pageSize: 10,
+    recentListsOnly: true,
+  })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) - The API name of a supported object.
+- **`pageSize`** (Number) - The number of list records viewed at one time. The default value is `20`. Valid values are `1–2000`.
+- **`pageToken`** (Number) - A token that represents the page offset. To indicate where the page starts, use this value with the `pageSize` parameter. The maximum offset is `2000`, and the default is `0`.
+- **`q`** (String) - A search term to filter the results. Wildcards are supported.
+- **`recentListsOnly`** (Boolean) - Indicates whether to get recent lists only (`true`) or not (`false`). The default is `false`.
+
+## Returns
+
+- **`data`** – List Info Summary Collection
+- **`error`** – FetchResponse
+
+## Usage
+
+This example fetches the list of list views for an object and displays the list view labels.
+
+### **JavaScript**
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListInfosByObjectName } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class GetListOfLists extends LightningElement {
+  error;
+  lists;
+
+  @wire(getListInfosByObjectName, {
+    objectApiName: ACCOUNT_OBJECT.objectApiName,
+    pageSize: 10,
+  })
+  listOfLists({ error, data }) {
+    if (data) {
+      this.lists = data.lists;
+      this.error = undefined;
+    } else if (error) {
+      this.error = error;
+      this.lists = undefined;
+    }
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/reference-get-list-object-info.md

@@ -0,0 +1,55 @@
+# `getListObjectInfo`
+
+This wire adapter gets the metadata for a list view object.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListObjectInfo } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class Example extends LightningElement {
+  @wire(getListObjectInfo, { objectApiName: ACCOUNT_OBJECT })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) - The API name of a supported object.
+
+## Returns
+
+- **`data`** – List Object Info
+- **`error`** – FetchResponse
+
+## Usage
+
+This example fetches the list object info for an object and then displays the list of columns for the object.
+
+### **JavaScript**
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListObjectInfo } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class WireListInfoByName extends LightningElement {
+  error;
+  columns;
+
+  @wire(getListObjectInfo, {
+    objectApiName: ACCOUNT_OBJECT.objectApiName,
+  })
+  listObjectInfo({ error, data }) {
+    if (data) {
+      this.columns = data.columns;
+      this.error = undefined;
+    } else if (error) {
+      this.error = error;
+      this.columns = undefined;
+    }
+  }
+}
+```

package/agents/lds/resources/lwc/guides/reference/reference-get-list-preferences.md

@@ -0,0 +1,60 @@
+# `getListPreferences`
+
+Use this wire adapter to get the preferences for a list view.
+
+## Syntax
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListPreferences } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class Example extends LightningElement {
+  @wire(getListPreferences, {
+    objectApiName: ACCOUNT_OBJECT,
+    listViewApiName: 'AllAccounts',
+  })
+  propertyOrFunction;
+}
+```
+
+## Parameters
+
+- **`objectApiName`** (String, Required) - The API name of a supported object.
+- **`listViewApiName`** (String, Required) - The API name of a list view, such as `"AllAccounts"`.
+
+## Returns
+
+- **`data`** – List Preferences
+- **`error`** – FetchResponse
+
+## Usage
+
+This example fetches the preferences for a list view and displays the column widths for each displayed column.
+
+### **JavaScript**
+
+```js
+import { LightningElement, wire } from 'lwc';
+import { getListPreferences } from 'lightning/uiListsApi';
+import ACCOUNT_OBJECT from '@salesforce/schema/Account';
+
+export default class GetListPrefs extends LightningElement {
+  error;
+  columnWidths;
+
+  @wire(getListPreferences, {
+    objectApiName: ACCOUNT_OBJECT.objectApiName,
+    listViewApiName: 'AllAccounts',
+  })
+  listPrefs({ error, data }) {
+    if (data) {
+      this.columnWidths = Object.entries(data.columnWidths);
+      this.error = undefined;
+    } else if (error) {
+      this.error = error;
+      this.columnWidths = undefined;
+    }
+  }
+}
+```