Skip to content

Commit 1aebfbf

Browse files
Merge pull request #2243 from syncfusion-content/1008749-pdfViewer
1008749: Updated UG documentation for custom PDF Viewer SDK assistant
2 parents 986b4a6 + 1c9c92b commit 1aebfbf

8 files changed

Lines changed: 14 additions & 5 deletions

File tree

41.7 KB
Loading
87.4 KB
Loading
56.1 KB
Loading
82.4 KB
Loading
73.1 KB
Loading
74.8 KB
Loading
51.6 KB
Loading

Document-Processing/ai-coding-assistant/MCP-Server/pdfviewersdk.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,19 @@ There are two options:
8686

8787
### Syncfusion<sup>&reg;</sup> Code Studio
8888

89-
* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the ```Custom Servers``` tab.
90-
* Enter the Server Name as ```pdfviewersdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/pdfviewersdk-assistant```.
91-
* 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**.
89+
* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace
90+
![Code Studio Marketplace](images/pdfviewer/code-studio-marketplace.png)
91+
* Go to the ```Custom Servers``` tab and click **Add MCP Servers**
92+
![Custom Server Tab](images/pdfviewer/mcp-custom-server.png)
93+
* In the dialog that appears, select **Accept and Continue** to launch the runtime window for configuring the PDF Viewer SDK MCP.
94+
![Run Time Window](images/pdfviewer/mcp-runtime-window.png)
95+
* Choose the NPM package installation mode. Enter the command **@syncfusion/pdfviewersdk-assistant** in the runtime window and press **Enter**
96+
![NPM package](images/pdfviewer/mcp-npm-package.png)
97+
* When prompted, click allow in the opened options and select **Direct API key**. Enter the API key generated from the [Syncfusion API key](https://www.syncfusion.com/account/api-key), then press **Enter**.
98+
![Syncfusion API key](images/pdfviewer/mcp-syncfusion-api-key.png)
99+
* Provide server name such as ```syncfusion-pdfviewersdk-assistant```, then press **Enter**. The PDF Viewer SDK MCP server will get installed.
92100
* Once installed, the server will appear in the User Installed Server list and will be added to the **config.yaml** file.
101+
![PDF Viewer MCP server](images/pdfviewer/mcp-server-installed.png)
93102
* 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).
94103

95104
For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers).
@@ -119,7 +128,7 @@ For additional details, see the Code Studio [documentation](https://help.syncfus
119128
```
120129

121130
* 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/pdfviewersdk-assistant">SyncfusionPDFViewerSDKAssistant</a> server directly from the settings interface without additional commands.
122-
131+
![Start PDF Viewer AI Assistant](images/pdfviewer/mcp-start-pdfviewer.png)
123132
* Confirm that [SyncfusionPDFViewerSDKAssistant](https://www.npmjs.com/package/@syncfusion/pdfviewersdk-assistant) is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
124133
* ```SyncfusionPDFViewerSDKAssistant is running...``` (in VS Code)
125134

@@ -216,7 +225,7 @@ Here are some effective ways to use [SyncfusionPDFViewerSDKAssistant](https://ww
216225
* "Show me a code snippet to load a PDF from Google Drive into Syncfusion PDF Viewer using React"
217226
* "How do I toggle the annotation toolbar using Angular PDF Viewer"
218227
* "Explain how to open the thumbnail panel programmatically in Syncfusion PDF Viewer using Vue."
219-
* "Provide code to restrict zoom levels between 150% and 300% in Javascript PDF Viewer."
228+
* "Provide code to restrict zoom levels between 150% and 300% in JavaScript PDF Viewer."
220229

221230
## Troubleshooting
222231

0 commit comments

Comments
 (0)