Skip to content

Commit e6f1257

Browse files
Add UG Documentation for the AI Coding assistants for DocumentSDK Libraries
1 parent 643be6b commit e6f1257

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title: SyncfusionDocumentSDKAssistant MCP Server Overview and Setup – Syncfusion
44
description: Explore the SyncfusionDocumentSDKAssistant MCP server, its key benefits, prerequisites, and integration guidance for enhancing Syncfusion DocumentSDK development workflows.
55
platform: document-processing
6-
control: Installation and Deployment
6+
control: AI coding assistant
77
documentation: ug
88
---
99

@@ -45,11 +45,11 @@ This ensures users can fully leverage Syncfusion<sup>&reg;</sup> components to e
4545

4646
## Installation and setup
4747

48-
Before you can invoke the SyncfusionDocumentSDKAssistant MCP server, you need to configure your MCP client with these core settings. The **Generic MCP Server Settings** shown below are identical across all clients:
48+
Before you can invoke the ```SyncfusionDocumentSDKAssistant``` MCP server, you need to configure your MCP client with these core settings. The **Generic MCP Server Settings** shown below are identical across all clients:
4949

5050
### Generic MCP Server Settings
5151

52-
* **npm package name**: @syncfusion/documentsdk-assistant
52+
* **npm package name**: ```@syncfusion/documentsdk-assistant```
5353
* **Type**: stdio (standard input/output transport)
5454
* **Command**: npx
5555
* **Arguments**: -y
@@ -67,18 +67,18 @@ You need to add your [Syncfusion API key](https://syncfusion.com/account/api-key
6767

6868
### Syncfusion<sup>&reg;</sup> Code Studio
6969

70-
* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the Custom Servers tab.
71-
* Enter the Server Name as documentsdk-mcp, choose Server Type as npm package, and set the NPM Package name to @syncfusion/documentsdk-assistant.
72-
* 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**.
70+
* In [Code Studio](https://www.syncfusion.com/code-studio/), open MCP Marketplace and navigate to the ```Custom Servers``` tab.
71+
* Enter the Server Name as ```documentsdk-mcp```, choose Server Type as npm package, and set the NPM Package name to ```@syncfusion/documentsdk-assistant```.
72+
* 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**.
7373
* Once installed, the server will appear in the User Installed Server list and will be added to the **config.yaml** file.
7474
* 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).
7575

7676
For additional details, see the Code Studio [documentation](https://help.syncfusion.com/code-studio/reference/configure-properties/mcp/customservers).
7777

7878
### VS Code (GitHub Copilot MCP)
79-
1. To configure an MCP server for a specific workspace, you can create a .vscode/mcp.json file in your workspace folder.
79+
1. To configure an MCP server for a specific workspace, you can create a ```.vscode/mcp.json``` file in your workspace folder.
8080

81-
~~~
81+
~~~json
8282
{
8383
"servers": {
8484
"syncfusion-documentsdk-assistant": {
@@ -100,13 +100,13 @@ For additional details, see the Code Studio [documentation](https://help.syncfus
100100

101101
3. Confirm that [SyncfusionDocumentSDKAssistant](https://help.syncfusion.com/document-processing/ai-coding-assistants/mcp-server) is being used (this does not happen automatically). Look for a statement in the output, which is similar to:
102102

103-
* SyncfusionDocumentSDKAssistant is running... (in VS Code)
103+
* ```SyncfusionDocumentSDKAssistant is running...``` (in VS Code)
104104

105105
### Cursor
106106

107107
To configure an MCP server for a specific workspace, you can create a .cursor/mcp.json file in your workspace folder.
108108

109-
~~~
109+
~~~json
110110
{
111111
"mcpServers": {
112112
"syncfusion-documentsdk-assistant": {
@@ -128,9 +128,9 @@ To configure an MCP server for a specific workspace, you can create a .cursor/mc
128128

129129
1. Go to Settings -> Tools -> AI Assistant -> Model Context Protocol (MCP).
130130
2. Click + Add to add a new MCP server configuration.
131-
3. In the New MCP Server dialog, switch the dropdown as As JSON and add the following config:
131+
3. In the New MCP Server dialog, switch the dropdown as ```As JSON``` and add the following config:
132132

133-
~~~
133+
~~~json
134134
{
135135
"mcpServers": {
136136
"syncfusion-documentsdk-assistant": {
@@ -176,10 +176,10 @@ Syncfusion® MCP Servers provide full access to all AI interaction modes — Ask
176176

177177
### Best Practices for Effective Usage
178178

179-
1. Be specific : Mention both platform and component (e.g., "How to digitally sign a PDF document using Syncfusion PDF library in .NET Core app?").
180-
2. Provide context : Include details about your use case for more targeted solutions.
181-
3. Use descriptive queries : Avoid vague questions that lack necessary context.
182-
4. Start fresh for new topics : Begin a new chat session when switching components or topics
179+
1. ```Be specific```: Mention both platform and component (e.g., "How to digitally sign a PDF document using Syncfusion PDF library in .NET Core app?").
180+
2. ```Provide context:``` Include details about your use case for more targeted solutions.
181+
3. ```Use descriptive queries```: Avoid vague questions that lack necessary context.
182+
4. ```Start fresh for new topics```: Begin a new chat session when switching components or topics
183183

184184
### Example Queries
185185

Document-Processing/ai-coding-assistant/overview/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ layout: post
33
title : Overview of the AI Coding Assistants for Document Processing - Syncfusion
44
description: Get a quick overview of Syncfusion’s AI Coding Assistants that simplify document processing and deliver query results efficiently
55
platform: document-processing
6-
control: Installation and Deployment
6+
control: AI coding assistant
77
documentation: ug
88
---
99

0 commit comments

Comments
 (0)