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/documentsdk.md
+29-4Lines changed: 29 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,11 +55,30 @@ Before you can invoke the ```SyncfusionDocumentSDKAssistant``` MCP server, you n
55
55
***Arguments**: -y
56
56
***Server name**: syncfusionDocumentSDKAssistant
57
57
58
-
You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file:
58
+
#### API Key Configuration
59
59
60
+
Login to your [Syncfusion account](http://syncfusion.com/account/) and generate an API Key from the [API Key page](https://www.syncfusion.com/account/api-key). Replace `YOUR_API_KEY_FILE_PATH` or `YOUR_API_KEY` in the configuration files with your generated key.
61
+
62
+
There are two options:
63
+
64
+
***Using an API Key File (Recommended)**
65
+
66
+
Store your API key in a separate file and reference its path in the `Syncfusion_API_Key_Path` environment parameter. This approach is more secure as you don't expose the key directly in configuration files.
* 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.
120
+
* After updating the configuration in mcp.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
121
101
122
* 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
123
@@ -118,6 +139,8 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file:
58
+
#### API Key Configuration
59
59
60
-
```json
61
-
"env": {
62
-
"Syncfusion_API_Key": "YOUR_API_KEY"
63
-
}
64
-
```
60
+
Login to your [Syncfusion account](http://syncfusion.com/account/) and generate an API Key from the [API Key page](https://www.syncfusion.com/account/api-key). Replace `YOUR_API_KEY_FILE_PATH` or `YOUR_API_KEY` in the configuration files with your generated key.
61
+
62
+
There are two options:
63
+
64
+
***Using an API Key File (Recommended)**
65
+
66
+
Store your API key in a separate file and reference its path in the `Syncfusion_API_Key_Path` environment parameter. This approach is more secure as you don't expose the key directly in configuration files.
Paste your `Syncfusion_API_Key` directly in the configuration file's environment parameter.
78
+
79
+
~~~json
80
+
"env": {
81
+
"Syncfusion_API_Key": "YOUR_API_KEY"
82
+
}
83
+
~~~
65
84
66
85
[SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant) can be configured in various MCP clients. Below are setup instructions for popular environment:
67
86
68
-
### Syncfusion<supstyle="font-size:70%">®</sup> Code Studio
87
+
### Syncfusion<sup>®</sup> Code Studio
69
88
70
89
* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the ```Custom Servers``` tab.
71
90
* Enter the Server Name as ```spreadsheeteditorsdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/spreadsheeteditorsdk-assistant```.
@@ -90,14 +109,16 @@ For additional details, see the Code Studio [documentation](https://help.syncfus
* 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 [SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant) server directly from the settings interface without additional commands.
121
+
* After updating the configuration in mcp.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/spreadsheeteditorsdk-assistant">SyncfusionSpreadsheetEditorSDKAssistant</a> server directly from the settings interface without additional commands.
101
122
102
123
* Confirm that [SyncfusionSpreadsheetEditorSDKAssistant](https://www.npmjs.com/package/@syncfusion/spreadsheeteditorsdk-assistant) is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
103
124
*```SyncfusionSpreadsheetEditorSDKAssistant is running...``` (in VS Code)
@@ -119,7 +140,9 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
0 commit comments