Skip to content

Commit 35605e9

Browse files
Merge pull request #1714 from syncfusion-content/MCP_Server_Folder_Change
Add UG Documentation for the AI Coding assistants for DocumentSDK Libraries
2 parents 96d2037 + 10d5206 commit 35605e9

File tree

3 files changed

+20
-23
lines changed

3 files changed

+20
-23
lines changed

Document-Processing-toc.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
<li>AI Coding Assistant
1313
<ul>
1414
<li>
15-
<a href="/document-processing/ai-coding-assistant/overview/overview">OverView</a>
15+
<a href="/document-processing/ai-coding-assistant/overview">Overview</a>
1616
</li>
1717
<li>
18-
<a href="/document-processing/ai-coding-assistant/mcp-server/mcp-server">MCP Server</a>
18+
<a href="/document-processing/ai-coding-assistant/mcp-server">MCP Server</a>
1919
</li>
2020
</ul>
2121
</li>

Document-Processing/ai-coding-assistant/mcp-server/mcp-server.md renamed to Document-Processing/ai-coding-assistant/mcp-server.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ documentation: ug
1212

1313
## Overview
1414

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>&reg;</sup> Document Processing libraries, such as PDF, Word, Excel, and PowerPoint.
15+
The <a href ="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>&reg;</sup> Document Processing libraries, such as PDF, Word, Excel, and PowerPoint.
1616

1717
### Key Benefits
1818

@@ -22,7 +22,7 @@ The SyncfusionDocumentSDKAssistant a specialized [Model Context Protocol (MCP)](
2222

2323
## Prerequisites
2424

25-
Before using <a href="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant</a>, ensure you have:
25+
Before using <a href="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a>, ensure you have:
2626

2727
* Required [node](https://nodejs.org/en/) version >= 18
2828
* A [compatible MCP client](https://modelcontextprotocol.io/clients) (VS Code with GitHub Copilot, [Syncfusion<sup>&reg;</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
6363
}
6464
~~~
6565

66-
<a href="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+
<a href="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a> can be configured in various MCP clients. Below are setup instructions for popular environments:
6767

6868
### Syncfusion<sup>&reg;</sup> Code Studio
6969

@@ -76,7 +76,7 @@ You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key
7676
For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers).
7777

7878
### 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.
8080

8181
~~~json
8282
{
@@ -96,12 +96,12 @@ For additional details, see the Code Studio [documentation](https://help.syncfus
9696
}
9797
~~~
9898

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 <a href ="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 <a href ="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a> server directly from the settings interface without additional commands.
100100

101-
3. Confirm that <a href ="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 <a href ="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:
102102

103103
* ```SyncfusionDocumentSDKAssistant is running...``` (in VS Code)
104-
4. For more details, refer to the official <a href = "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 <a href = "https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022"> Visual Studio documentation </a>.
105105

106106
### Cursor
107107

@@ -128,9 +128,9 @@ For more details, refer to the <a href = "https://docs.cursor.com/en/context/mcp
128128

129129
### JetBrains IDEs
130130

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:
134134

135135
~~~json
136136
{
@@ -149,7 +149,7 @@ For more details, refer to the <a href = "https://docs.cursor.com/en/context/mcp
149149
}
150150
~~~
151151

152-
4. Click OK and Apply.
152+
* Click OK and Apply.
153153

154154
For further assistance, see the <a href ="https://www.jetbrains.com/help/ai-assistant/mcp.html#connect-to-an-mcp-server">JetBrains documentation</a>.
155155

@@ -165,7 +165,9 @@ To activate the SyncfusionDocumentSDKAssistant MCP server:
165165
* ‘/syncfusion-documentsdk’
166166
*@syncfusion-documentsdk
167167
* ‘@ask_syncfusion_documentsdk’
168+
168169
In VS Code, you can also use #SyncfusionDocumentSDKAssistant to explicitly invoke the MCP server.
170+
169171
2. Grant the SyncfusionDocumentSDKAssistant MCP server a permission to run for this session, workspace, or always.
170172
3. For best results, start a new chat for each new topic to maintain clean context.
171173

@@ -182,7 +184,7 @@ Syncfusion® MCP Servers provide full access to all AI interaction modes — Ask
182184

183185
### Example Queries
184186

185-
Here are some effective ways to use SyncfusionDocumentSDKAssistant:
187+
Here are some effective ways to use <a href ="https://www.npmjs.com/package/@syncfusion/documentsdk-assistant">SyncfusionDocumentSDKAssistant</a>:
186188

187189
* "Create an Excel file with formulas, charts, and conditional formatting using Syncfusion in WPF."
188190
* "How to perform a mail merge in a Word document using Syncfusion Word library?"
@@ -203,7 +205,7 @@ If you encounter issues:
203205

204206
Product support is available through the following mediums.
205207

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
207209
* [Community forum](https://www.syncfusion.com/forums/document-sdk)
208210
* [Request feature or report bug](https://www.syncfusion.com/feedback/document-sdk)
209211
* Live chat
@@ -215,7 +217,3 @@ Product support is available through the following mediums.
215217

216218

217219

218-
219-
220-
221-

Document-Processing/ai-coding-assistant/overview/overview.md renamed to Document-Processing/ai-coding-assistant/overview.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The **Syncfusion<sup>&reg;</sup> AI Coding Assistant** are designed to streamlin
1717

1818
AI Coding Assistant:
1919

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>&reg;</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>&reg;</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)**.
2121

2222

2323
## Getting Started
@@ -48,8 +48,7 @@ This ensures users can fully leverage Syncfusion<sup>&reg;</sup> components to e
4848
* Initial Setup: Use the tools to quickly add and configure Syncfusion® components in your .NET applications.
4949
* Feature Tuning: Enable or disable component features through prompt-based configuration for tailored functionality.
5050
* 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>&reg;</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>&reg;</sup> Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction) for in-depth information.
5352
* 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).
5453

5554
>Always check AI-generated content and code for accuracy before using it.
@@ -71,7 +70,7 @@ The Syncfusion<sup>&reg;</sup> AI Coding Assistant is designed with privacy in m
7170
## See also
7271

7372
* Add the <a href="https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server">SyncfusionDocumentSDKAssistant MCP Server</a> to an MCP-enabled client
74-
* Syncfusion<sup>&reg;</sup> Document [SDK Documentation](https://help.syncfusion.com/document-processing/introduction)
73+
* [Syncfusion<sup>&reg;</sup> Document SDK Documentation](https://help.syncfusion.com/document-processing/introduction)
7574

7675

7776

0 commit comments

Comments
 (0)