diff --git a/Document-Processing/ai-coding-assistant/mcp-server.md b/Document-Processing/ai-coding-assistant/mcp-server.md index dca89023a..baf82dbe7 100644 --- a/Document-Processing/ai-coding-assistant/mcp-server.md +++ b/Document-Processing/ai-coding-assistant/mcp-server.md @@ -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" } ~~~ @@ -89,6 +108,8 @@ 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" } } @@ -96,7 +117,7 @@ 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 SyncfusionDocumentSDKAssistant 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 SyncfusionDocumentSDKAssistant server directly from the settings interface without additional commands. * Confirm that SyncfusionDocumentSDKAssistant is being used (this does not happen automatically). Look for a statement in the output, which is similar to: @@ -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" } } @@ -142,6 +165,8 @@ For more details, refer to the