Skip to content

Commit 1e2407b

Browse files
Bold Create Agentsuriyaprakasamr
andcommitted
Add WebMCP getting-started sample for JavaScript DOCX Editor
Co-authored-by: suriyaprakasamr <302142999+suriyaprakasamr@users.noreply.github.com>
1 parent eb1af18 commit 1e2407b

3 files changed

Lines changed: 128 additions & 0 deletions

File tree

‎webmcp/getting-started/README.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Syncfusion&reg; JavaScript (ES5) DOCX Editor (Document Editor) - WebMCP Getting Started
2+
3+
This sample demonstrates how to enable and configure the WebMCP (Model Context Protocol) support in the Syncfusion<sup style="font-size:70%">&reg;</sup> JavaScript (ES5) DOCX Editor (Document Editor) using the `DocumentEditorContainer` component with the Ribbon toolbar.
4+
5+
# Key Features
6+
7+
* [Enables WebMCP support](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/overview?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples) 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.
9+
* Retrieves the list of registered WebMCP tools using the `getWebMcpTools` method, which exposes editing, formatting, and document management operations to connected AI clients.
10+
* Supports intercepting WebMCP tool executions with the `beforeWebMcpToolExecute` event, allowing you to validate or restrict tool usage before it runs.
11+
* Shows a [confirmation dialog](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/dialog?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples) for write operations such as `replaceAll`, `insertText`, `paste`, `insertBookmark`, `enforceProtection`, `stopProtection`, `insertField`, `insertEditingRegion`, `formatCharacter`, `formatParagraph`, `insertImage`, and `insertHyperlink`, preventing unintended modifications by AI agents.
12+
* Supports the [ribbon interface](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/ribbon?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples) using the `toolbarMode` property set to `Ribbon`, providing tab-based commands similar to Microsoft Word.
13+
* Supports document elements like text, [image](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/image?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [table](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/table?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), fields, [bookmark](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/bookmark?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [shapes](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/shapes?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [section](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/section-format?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [header and footer](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/header-footer?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples).
14+
* Provides support to [find and replace](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/find-and-replace?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples) text within the document.
15+
* Supports all the common editing and formatting operations along with [undo and redo](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/history?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples).
16+
* Provides a [server-side helper library](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/web-services-overview?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples) to open the Word documents like DOCX, DOC, WordML, RTF, and Text, by converting it to SFDT file format.
17+
18+
# Resources
19+
20+
- **Documentation:** [Syncfusion® JavaScript (ES5) DOCX Editor - Documentation](https://help.syncfusion.com/document-processing/word/word-processor/javascript-es5/overview?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples)
21+
22+
- **Online demo:** [Syncfusion® JavaScript (ES5) DOCX Editor - Online demo](https://document.syncfusion.com/demos/docx-editor/javascript-es5/#/material3/document-editor/default.html?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples)
23+
24+
# Support and feedback
25+
26+
For any other queries, reach our [Syncfusion® support team](https://support.syncfusion.com/?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples) or post the queries through the [community forums](https://www.syncfusion.com/forums?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples).
27+
28+
Request new feature through [Syncfusion® feedback portal](https://www.syncfusion.com/feedback?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples).
29+
30+
# License
31+
32+
This is a commercial product and requires a paid license for possession or use. Syncfusion's licensed software, including this component, is subject to the terms and conditions of [Syncfusion's EULA](https://www.syncfusion.com/license/studio/22.2.5/syncfusion_essential_studio_eula.pdf?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples). You can purchase a license [here](https://www.syncfusion.com/sales/products?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples) or start a free 30\-day trial [here](https://www.syncfusion.com/account/manage-trials/start-trials?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples).
33+
34+
# About Syncfusion&reg;
35+
36+
Founded in 2001 and headquartered in Research Triangle Park, N.C., Syncfusion&reg; has more than 29,000 customers and more than 1 million users, including large financial institutions, Fortune 500 companies, and global IT consultancies.
37+
38+
Today, we provide 1700+ components and frameworks for web ([Blazor](https://www.syncfusion.com/blazor-components?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [ASP.NET Core](https://www.syncfusion.com/aspnet-core-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [ASP.NET MVC](https://www.syncfusion.com/aspnet-mvc-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [ASP.NET WebForms](https://www.syncfusion.com/jquery/aspnet-webforms-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [JavaScript](https://www.syncfusion.com/javascript-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [Angular](https://www.syncfusion.com/angular-ui-components?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [React](https://www.syncfusion.com/react-ui-components?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [Vue](https://www.syncfusion.com/vue-ui-components?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), and [Flutter](https://www.syncfusion.com/flutter-widgets?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples)), mobile ([Xamarin](https://www.syncfusion.com/xamarin-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [Flutter](https://www.syncfusion.com/flutter-widgets?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [UWP](https://www.syncfusion.com/uwp-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), and [JavaScript](https://www.syncfusion.com/javascript-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [.NET MAUI](https://www.syncfusion.com/maui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples)) and desktop development ([WinForms](https://www.syncfusion.com/winforms-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [WPF](https://www.syncfusion.com/wpf-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [WinUI](https://www.syncfusion.com/winui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [Flutter](https://www.syncfusion.com/flutter-widgets?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), [UWP](https://www.syncfusion.com/uwp-ui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples), and [.NET MAUI](https://www.syncfusion.com/maui-controls?utm_source=github&utm_medium=listing&utm_campaign=github-javascript-es5-docx-editor-examples)) a. We provide ready-to-deploy enterprise software for dashboards, reports, data integration, and big data processing. Many customers have saved millions in licensing fees by deploying our software.

‎webmcp/getting-started/index.html‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<!DOCTYPE html>
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<title>Syncfusion JavaScript Document Editor - WebMCP</title>
5+
<!-- EJ2 Document Editor dependent theme -->
6+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-base/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
7+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-buttons/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
8+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-inputs/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
9+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-popups/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
10+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-lists/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
11+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-navigations/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
12+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-splitbuttons/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
13+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-dropdowns/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
14+
<!-- EJ2 Document Editor theme -->
15+
<link href="https://cdn.syncfusion.com/ej2/33.2.3/ej2-documenteditor/styles/tailwind3.css" rel="stylesheet" type="text/css" rel='nofollow' />
16+
<!-- EJ2 Document Editor dependent scripts -->
17+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-base/dist/global/ej2-base.min.js" type="text/javascript"></script>
18+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-data/dist/global/ej2-data.min.js" type="text/javascript"></script>
19+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-svg-base/dist/global/ej2-svg-base.min.js" type="text/javascript"></script>
20+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-file-utils/dist/global/ej2-file-utils.min.js" type="text/javascript"></script>
21+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-compression/dist/global/ej2-compression.min.js" type="text/javascript"></script>
22+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-pdf-export/dist/global/ej2-pdf-export.min.js" type="text/javascript"></script>
23+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-buttons/dist/global/ej2-buttons.min.js" type="text/javascript"></script>
24+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-popups/dist/global/ej2-popups.min.js" type="text/javascript"></script>
25+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-splitbuttons/dist/global/ej2-splitbuttons.min.js" type="text/javascript"></script>
26+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-inputs/dist/global/ej2-inputs.min.js" type="text/javascript"></script>
27+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-lists/dist/global/ej2-lists.min.js" type="text/javascript"></script>
28+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-navigations/dist/global/ej2-navigations.min.js" type="text/javascript"></script>
29+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-dropdowns/dist/global/ej2-dropdowns.min.js" type="text/javascript"></script>
30+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-calendars/dist/global/ej2-calendars.min.js" type="text/javascript"></script>
31+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-charts/dist/global/ej2-charts.min.js" type="text/javascript"></script>
32+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-office-chart/dist/global/ej2-office-chart.min.js" type="text/javascript"></script>
33+
<!-- EJ2 Document Editor script -->
34+
<script src="https://cdn.syncfusion.com/ej2/33.2.3/ej2-documenteditor/dist/global/ej2-documenteditor.min.js" type="text/javascript"></script>
35+
</head>
36+
<body>
37+
<!-- Element that renders the Document Editor -->
38+
<div id='DocumentEditor'></div>
39+
<script src="index.js" type="text/javascript"></script>
40+
</body>
41+
</html>

‎webmcp/getting-started/index.js‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// Inject required modules
2+
ej.documenteditor.DocumentEditorContainer.Inject(ej.documenteditor.Toolbar, ej.documenteditor.Ribbon);
3+
4+
// Initialize Document Editor Container component with WebMCP enabled
5+
var documenteditorcontainer = new ej.documenteditor.DocumentEditorContainer({
6+
height: '590px',
7+
enableWebMcp: true,
8+
toolbarMode: 'Ribbon',
9+
webMcpSettings: { name: 'container' },
10+
created: function () {
11+
// Get the registered WebMCP tools.
12+
var webMcpTools = documenteditorcontainer.getWebMcpTools();
13+
14+
// Set document name.
15+
documenteditorcontainer.documentEditor.documentName = 'WebMCP Tool Demo';
16+
17+
// Update document title.
18+
document.title = 'WebMCP Tool Demo - DocumentEditorContainer';
19+
},
20+
beforeWebMcpToolExecute: function (args) {
21+
// For write operations, show confirmation dialog.
22+
var writeOperations = [
23+
'replaceAll',
24+
'insertText',
25+
'paste',
26+
'insertBookmark',
27+
'enforceProtection',
28+
'stopProtection',
29+
'insertField',
30+
'insertEditingRegion',
31+
'formatCharacter',
32+
'formatParagraph',
33+
'insertImage',
34+
'insertHyperlink'];
35+
36+
if (args.toolName) {
37+
var toolName = args.toolName.indexOf('_') !== -1 ? args.toolName.substring(args.toolName.indexOf('_') + 1) : args.toolName;
38+
39+
if (writeOperations.indexOf(toolName) !== -1) {
40+
args.showConfirmationDialog = true;
41+
}
42+
}
43+
}
44+
});
45+
46+
// Use the following service URL only for demo purposes
47+
documenteditorcontainer.serviceUrl = 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/';
48+
// Render the DocumentEditorContainer control
49+
documenteditorcontainer.appendTo('#DocumentEditor');

0 commit comments

Comments
 (0)