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/mcp-server.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ layout: post
3
3
title: SyncfusionDocumentSDKAssistant MCP Server Overview and Setup – Syncfusion
4
4
description: Explore the SyncfusionDocumentSDKAssistant MCP server, its key benefits, prerequisites, and integration guidance for enhancing Syncfusion DocumentSDK development workflows.
5
5
platform: document-processing
6
-
control: Installation and Deployment
6
+
control: AI coding assistant
7
7
documentation: ug
8
8
---
9
9
@@ -45,11 +45,11 @@ This ensures users can fully leverage Syncfusion<sup>®</sup> components to e
45
45
46
46
## Installation and setup
47
47
48
-
Before you can invoke the SyncfusionDocumentSDKAssistant MCP server, you need to configure your MCP client with these core settings. The **Generic MCP Server Settings** shown below are identical across all clients:
48
+
Before you can invoke the ```SyncfusionDocumentSDKAssistant``` MCP server, you need to configure your MCP client with these core settings. The **Generic MCP Server Settings** shown below are identical across all clients:
@@ -67,18 +67,18 @@ You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key
67
67
68
68
### Syncfusion<sup>®</sup> Code Studio
69
69
70
-
* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the Custom Servers tab.
71
-
* Enter the Server Name as documentsdk-mcp, choose Server Type as npm package, and set the NPM Package name to @syncfusion/documentsdk-assistant.
72
-
* Add an environment variable as Syncfusion_API_Key and value as your [Syncfusion API key](https://syncfusion.com/account/api-key), then click **Install Server**.
70
+
* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the ```Custom Servers``` tab.
71
+
* Enter the Server Name as ```documentsdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/documentsdk-assistant```.
72
+
* Add an environment variable as ```Syncfusion_API_Key``` and value as your [Syncfusion API key](https://syncfusion.com/account/api-key), then click **Install Server**.
73
73
* Once installed, the server will appear in the User Installed Server list and will be added to the **config.yaml** file.
74
74
* The server is now ready for use in Code Studio. For more details, refer to the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers).
75
75
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
+
1. 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
{
83
83
"servers": {
84
84
"syncfusion-documentsdk-assistant": {
@@ -100,13 +100,13 @@ For additional details, see the Code Studio [documentation](https://help.syncfus
100
100
101
101
3. Confirm that [SyncfusionDocumentSDKAssistant](https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server) is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
102
102
103
-
* SyncfusionDocumentSDKAssistant is running... (in VS Code)
103
+
*```SyncfusionDocumentSDKAssistant is running...``` (in VS Code)
104
104
105
105
### Cursor
106
106
107
107
To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder.
108
108
109
-
~~~
109
+
~~~json
110
110
{
111
111
"mcpServers": {
112
112
"syncfusion-documentsdk-assistant": {
@@ -128,9 +128,9 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
128
128
129
129
1. Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
130
130
2. Click + Add to add a new MCP server configuration.
131
-
3. In the New MCP Server dialog, switch the dropdown as As JSON and add the following config:
131
+
3. In the New MCP Server dialog, switch the dropdown as ```As JSON``` and add the following config:
132
132
133
-
~~~
133
+
~~~json
134
134
{
135
135
"mcpServers": {
136
136
"syncfusion-documentsdk-assistant": {
@@ -176,10 +176,10 @@ Syncfusion® MCP Servers provide full access to all AI interaction modes — Ask
176
176
177
177
### Best Practices for Effective Usage
178
178
179
-
1. Be specific: Mention both platform and component (e.g., "How to digitally sign a PDF document using Syncfusion PDF library in .NET Core app?").
180
-
2. Provide context : Include details about your use case for more targeted solutions.
181
-
3. Use descriptive queries: Avoid vague questions that lack necessary context.
182
-
4. Start fresh for new topics: Begin a new chat session when switching components or topics
179
+
1.```Be specific```: Mention both platform and component (e.g., "How to digitally sign a PDF document using Syncfusion PDF library in .NET Core app?").
180
+
2.```Provide context:``` Include details about your use case for more targeted solutions.
181
+
3.```Use descriptive queries```: Avoid vague questions that lack necessary context.
182
+
4.```Start fresh for new topics```: Begin a new chat session when switching components or topics
0 commit comments