You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Document-Processing/ai-coding-assistant/mcp-server.md
+15-17Lines changed: 15 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ documentation: ug
12
12
13
13
## Overview
14
14
15
-
The SyncfusionDocumentSDKAssistant a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion’s DocumentSDK libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building .NET applications with Syncfusion<sup>®</sup> Document Processing libraries, such as PDF, Word, Excel, and PowerPoint.
15
+
The <ahref ="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a> is a specialized [Model Context Protocol (MCP)](https://modelcontextprotocol.io/docs/getting-started/intro) server that provides intelligent assistance for developers using Syncfusion’s DocumentSDK libraries. This tool seamlessly integrates with compatible [MCP clients](https://modelcontextprotocol.io/clients) to enhance your development workflow when building .NET applications with Syncfusion<sup>®</sup> Document Processing libraries, such as PDF, Word, Excel, and PowerPoint.
16
16
17
17
### Key Benefits
18
18
@@ -22,7 +22,7 @@ The SyncfusionDocumentSDKAssistant a specialized [Model Context Protocol (MCP)](
22
22
23
23
## Prerequisites
24
24
25
-
Before using <ahref="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a>, ensure you have:
25
+
Before using <ahref="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a>, ensure you have:
26
26
27
27
* Required [node](https://nodejs.org/en/) version >= 18
28
28
* A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion<sup>®</sup> CodeStudio](https://www.syncfusion.com/code-studio/), etc.)
@@ -63,7 +63,7 @@ You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key
63
63
}
64
64
~~~
65
65
66
-
<ahref="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a> can be configured in various MCP clients. Below are setup instructions for popular environments:
66
+
<ahref="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a> can be configured in various MCP clients. Below are setup instructions for popular environments:
67
67
68
68
### Syncfusion<sup>®</sup> Code Studio
69
69
@@ -76,7 +76,7 @@ You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key
76
76
For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers).
77
77
78
78
### VS Code (GitHub Copilot MCP)
79
-
1. To configure an MCP server for a specific workspace, you can create a ```.vscode/mcp.json``` file in your workspace folder.
79
+
* To configure an MCP server for a specific workspace, you can create a ```.vscode/mcp.json``` file in your workspace folder.
80
80
81
81
~~~json
82
82
{
@@ -96,12 +96,12 @@ For additional details, see the Code Studio [documentation](https://help.syncfus
96
96
}
97
97
~~~
98
98
99
-
2. After updating the configuration in settings.json, you’ll notice a “Start” option at the top of the config. This allows you to easily start the <ahref ="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a> server directly from the settings interface without additional commands.
99
+
* After updating the configuration in settings.json, you’ll notice a “Start” option at the top of the config. This allows you to easily start the <ahref ="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a> server directly from the settings interface without additional commands.
100
100
101
-
3. Confirm that <ahref ="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a> is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
101
+
* Confirm that <ahref ="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a> is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
102
102
103
103
*```SyncfusionDocumentSDKAssistant is running...``` (in VS Code)
104
-
4. For more details, refer to the official <ahref = "https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022"> Visual Studio documentation </a>.
104
+
* For more details, refer to the official <ahref = "https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022"> Visual Studio documentation </a>.
105
105
106
106
### Cursor
107
107
@@ -128,9 +128,9 @@ For more details, refer to the <a href = "https://docs.cursor.com/en/context/mcp
128
128
129
129
### JetBrains IDEs
130
130
131
-
1. Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
132
-
2. Click + Add to add a new MCP server configuration.
133
-
3. In the New MCP Server dialog, switch the dropdown as ```As JSON``` and add the following config:
131
+
* Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
132
+
* Click + Add to add a new MCP server configuration.
133
+
* In the New MCP Server dialog, switch the dropdown as ```As JSON``` and add the following config:
134
134
135
135
~~~json
136
136
{
@@ -149,7 +149,7 @@ For more details, refer to the <a href = "https://docs.cursor.com/en/context/mcp
149
149
}
150
150
~~~
151
151
152
-
4. Click OK and Apply.
152
+
* Click OK and Apply.
153
153
154
154
For further assistance, see the <ahref ="https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server">JetBrains documentation</a>.
155
155
@@ -165,7 +165,9 @@ To activate the SyncfusionDocumentSDKAssistant MCP server:
165
165
* ‘/syncfusion-documentsdk’
166
166
* ‘@syncfusion-documentsdk’
167
167
* ‘@ask_syncfusion_documentsdk’
168
+
168
169
In VS Code, you can also use #SyncfusionDocumentSDKAssistant to explicitly invoke the MCP server.
170
+
169
171
2. Grant the SyncfusionDocumentSDKAssistant MCP server a permission to run for this session, workspace, or always.
170
172
3. For best results, start a new chat for each new topic to maintain clean context.
171
173
@@ -182,7 +184,7 @@ Syncfusion® MCP Servers provide full access to all AI interaction modes — Ask
182
184
183
185
### Example Queries
184
186
185
-
Here are some effective ways to use SyncfusionDocumentSDKAssistant:
187
+
Here are some effective ways to use <ahref ="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a>:
186
188
187
189
* "Create an Excel file with formulas, charts, and conditional formatting using Syncfusion in WPF."
188
190
* "How to perform a mail merge in a Word document using Syncfusion Word library?"
@@ -203,7 +205,7 @@ If you encounter issues:
203
205
204
206
Product support is available through the following mediums.
205
207
206
-
*[Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
208
+
*[Support ticket](https://support.syncfusion.com/support/tickets/create) - Guaranteed Response in 24 hours \| Unlimited tickets \| Holiday support
Copy file name to clipboardExpand all lines: Document-Processing/ai-coding-assistant/overview.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ The **Syncfusion<sup>®</sup> AI Coding Assistant** are designed to streamlin
17
17
18
18
AI Coding Assistant:
19
19
20
-
***The SyncfusionDocumentSDKAssistant MCP Server** is designed to process advanced prompts and return intelligent, context-aware code suggestions through [MCP-compatible clients](https://modelcontextprotocol.io/clients). It specifically enhances productivity when working with **Syncfusion<sup>®</sup> Document Processing libraries**, including **[PDF](https://help.syncfusion.com/document-processing/pdf/overview), [Word](https://help.syncfusion.com/document-processing/word/overview) (DocIO), [Excel](https://help.syncfusion.com/document-processing/excel/overview) (XlsIO), and [PowerPoint](https://help.syncfusion.com/document-processing/powerpoint/overview)**.
20
+
***The SyncfusionDocumentSDKAssistant MCP Server** is designed to process advanced prompts and return intelligent, context-aware code suggestions through [MCP-compatible clients](https://modelcontextprotocol.io/clients). It specifically enhances productivity when working with **Syncfusion<sup>®</sup> Document Processing libraries**, including **[PDF](https://help.syncfusion.com/document-processing/pdf/overview)**, **[Word](https://help.syncfusion.com/document-processing/word/overview) (DocIO)**, **[Excel](https://help.syncfusion.com/document-processing/excel/overview) (XlsIO)**, and **[PowerPoint](https://help.syncfusion.com/document-processing/powerpoint/overview) (Presentation)**.
21
21
22
22
23
23
## Getting Started
@@ -48,8 +48,7 @@ This ensures users can fully leverage Syncfusion<sup>®</sup> components to e
48
48
* Initial Setup: Use the tools to quickly add and configure Syncfusion® components in your .NET applications.
49
49
* Feature Tuning: Enable or disable component features through prompt-based configuration for tailored functionality.
50
50
* Data Binding: Generate sample data for testing and prototyping. Avoid using sensitive or production data to ensure security.
51
-
* Step-by-step explanations: Use annotated code to understand component behavior. Note that the level of detail may vary depending on
52
-
the tool, mode, and AI model used. Refer to the [Syncfusion<sup>®</sup> Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction) for in-depth information.
51
+
* Step-by-step explanations: Use annotated code to understand component behavior. Note that the level of detail may vary depending on the tool, mode, and AI model used. Refer to the [Syncfusion<sup>®</sup> Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction) for in-depth information.
53
52
* Troubleshooting: Resolve common issues with AI-generated suggestions. For complex problems, refer to [documentation](https://help.syncfusion.com/document-processing/introduction) or [support](https://support.syncfusion.com/support/tickets/create).
54
53
55
54
>Always check AI-generated content and code for accuracy before using it.
@@ -71,7 +70,7 @@ The Syncfusion<sup>®</sup> AI Coding Assistant is designed with privacy in m
71
70
## See also
72
71
73
72
* Add the <ahref="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant MCP Server</a> to an MCP-enabled client
0 commit comments