Skip to content

Commit f291d28

Browse files
986773 Update the api key filepath support in the mcp document - Dev
1 parent 4540fe3 commit f291d28

1 file changed

Lines changed: 29 additions & 4 deletions

File tree

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

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,30 @@ Before you can invoke the ```SyncfusionDocumentSDKAssistant``` MCP server, you n
5555
* **Arguments**: -y
5656
* **Server name**: syncfusionDocumentSDKAssistant
5757

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
5959

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.
67+
68+
**Supported file formats:** `.txt` or `.key` file
69+
70+
~~~json
71+
"env": {
72+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH" // "D:\\syncfusion-key.txt" (or) "D:\\syncfusion-key.key"
73+
}
6074
~~~
61-
"env": {
62-
"Syncfusion_API_Key": "YOUR_API_KEY"
75+
* **Direct API Key**
76+
77+
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"
6382
}
6483
~~~
6584

@@ -89,14 +108,16 @@ For additional details, see the Code Studio [documentation](https://help.syncfus
89108
"@syncfusion/documentsdk-assistant@latest"
90109
],
91110
"env": {
111+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
112+
// or
92113
"Syncfusion_API_Key": "YOUR_API_KEY"
93114
}
94115
}
95116
}
96117
}
97118
~~~
98119

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

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

@@ -118,6 +139,8 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
118139
"@syncfusion/documentsdk-assistant@latest"
119140
],
120141
"env": {
142+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
143+
// or
121144
"Syncfusion_API_Key": "YOUR_API_KEY"
122145
}
123146
}
@@ -142,6 +165,8 @@ For more details, refer to the <a href = "https://docs.cursor.com/en/context/mcp
142165
"@syncfusion/documentsdk-assistant@latest"
143166
],
144167
"env": {
168+
"Syncfusion_API_Key_Path": "YOUR_API_KEY_FILE_PATH",
169+
// or
145170
"Syncfusion_API_Key": "YOUR_API_KEY"
146171
}
147172
}

0 commit comments

Comments
 (0)