|
1 | | -# Essential JS 2 QuickStart |
| 1 | +# Syncfusion® JavaScript (ES6) DOCX Editor (Document Editor) - WebMCP Getting Started |
2 | 2 |
|
3 | | -This project is a skeleton application used to create [Essential JS 2](https://www.syncfusion.com/products/essential-js2) web application. |
| 3 | +This sample demonstrates how to enable and configure the WebMCP (Model Context Protocol) support in the Syncfusion<sup style="font-size:70%">®</sup> JavaScript (ES6) DOCX Editor (Document Editor) using the `DocumentEditorContainer` component with the Ribbon toolbar. |
4 | 4 |
|
5 | | ->This application uses the latest version of the [webpack-cli](https://webpack.js.org/api/cli/#commands). It requires node `v14.15.0` or higher. |
| 5 | +# Key Features |
6 | 6 |
|
7 | | -## Getting Started |
| 7 | +* Enables WebMCP support in the Document Editor Container using the `enableWebMcp` property, allowing AI agents to interact with the editor through the Model Context Protocol. |
| 8 | +* Registers the editor as a WebMCP tool provider using the `webMcpSettings` property, so AI assistants (like Chrome's built-in AI agent) can discover and invoke document editing tools. |
8 | 9 |
|
9 | | -To get started you need to clone the `ej2-quickstart` repository and navigate to `ej2-quickstart` location. |
10 | 10 |
|
11 | | -``` |
12 | | -git clone https://github.com/syncfusion/ej2-quickstart.git quickstart |
13 | | -cd quickstart |
14 | | -``` |
15 | | - |
16 | | -## Installing |
17 | | - |
18 | | -We can get all the Essential JS 2 components in a single npm package [`ej2`](https://www.npmjs.com/package/@syncfusion/ej2). |
19 | | - |
20 | | -We already configure the required packages in the `package.json` file. |
21 | | - |
22 | | -You can run the below command to install all dependent packages related to this seed project. |
23 | | - |
24 | | -``` |
25 | | -npm install |
26 | | -``` |
27 | | - |
28 | | -## Testing |
29 | | - |
30 | | -This application is preconfigured with End-to-End testing and the test case is written in Jasmine. |
31 | | - |
32 | | -We run the test scripts with [Protractor](http://www.protractortest.org/#/) end-to-end test runner. The test case file can be found in the `e2e` folder. |
33 | | - |
34 | | -Protractor can interact with our web application and verify the test scripts. |
35 | | - |
36 | | -We have to install WebDriver and also need to ensure it is updated. Open a separate terminal and run the below npm script. |
37 | | - |
38 | | -``` |
39 | | -npm run update-webdriver |
40 | | -``` |
41 | | - |
42 | | -Open another terminal and run the below npm script. It will start web server to serve our application. |
43 | | - |
44 | | -``` |
45 | | -npm run serve |
46 | | -``` |
47 | | - |
48 | | -Once the web server is up and running, we can run the end-to-end tests using the below npm script |
49 | | - |
50 | | -``` |
51 | | -npm run test |
52 | | -``` |
53 | | - |
54 | | -> **Note:** Since Protractor is using the Selenium Standalone Server, the Java Development Kit (JDK) need to be installed in your local machine. |
55 | | -
|
56 | | -If JDK is not installed in your local machine, you can download it from [here](http://www.oracle.com/technetwork/java/javase/downloads/index.html). |
57 | | - |
58 | | -## Running |
59 | | - |
60 | | -The application is configured with [webpack-dev-server](https://webpack.js.org/configuration/dev-server/#devserver), so it will serve the web application in your default browser. |
61 | | - |
62 | | -We have used [Webpack](https://github.com/webpack/webpack) for module loading. |
63 | | - |
64 | | -You can use the below npm script to run the web application. |
65 | | - |
66 | | -``` |
67 | | -npm run start |
68 | | -``` |
69 | | - |
70 | | -## Resources |
71 | | - |
72 | | -You can also refer the below resources to know more details about Essential JS 2 components. |
73 | | - |
74 | | -* [Pure JS Demos](http://ej2.syncfusion.com/demos/) |
75 | | -* [Pure JS Documentation](http://ej2.syncfusion.com/documentation/) |
0 commit comments