Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions Document-Processing/ai-coding-assistant/mcp-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,30 @@ Before you can invoke the ```SyncfusionDocumentSDKAssistant``` MCP server, you n
* **Arguments**: -y
* **Server name**: syncfusionDocumentSDKAssistant

You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key) as an env parameter in the configuration file:
#### API Key Configuration

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.

There are two options:

* **Using an API Key File (Recommended)**

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.

**Supported file formats:** `.txt` or `.key` file

~~~json
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
}
~~~
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
* **Direct API Key**

Paste your `Syncfusion_API_Key` directly in the configuration file's environment parameter.

~~~json
"env": {
"Syncfusion_API_Key": "YOUR_API_KEY"
}
~~~

Expand Down Expand Up @@ -89,14 +108,16 @@ For additional details, see the Code Studio [documentation](https://help.syncfus
"@syncfusion/documentsdk-assistant@latest"
],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
}
}
~~~

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

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

Expand All @@ -118,6 +139,8 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
"@syncfusion/documentsdk-assistant@latest"
],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
Expand All @@ -142,6 +165,8 @@ For more details, refer to the <a href = "https://docs.cursor.com/en/context/mcp
"@syncfusion/documentsdk-assistant@latest"
],
"env": {
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
// or
"Syncfusion_API_Key": "YOUR_API_KEY"
}
}
Expand Down