You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/concepts/mcp.md
+36-8Lines changed: 36 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,9 +28,13 @@ Run the setup command in your terminal for your IDE of choice from the [Supporte
28
28
Install the [Defang CLI](/docs/getting-started.mdx#install-the-defang-cli) using [Curl](https://curl.se/) or [Homebrew](https://brew.sh/)
29
29
30
30
```bash
31
-
defang mcp setup --client=<your-ide>
31
+
defang mcp setup
32
32
```
33
33
34
+
An interactive prompt will appear asking you to select your IDE(s) from a list of supported IDE(s). Select your IDE(s) by using the spacebar and arrow keys to navigate and press enter to confirm your selection.
35
+

36
+
37
+
Please ensure that your selected IDE(s) are updated to the latest version to ensure compatibility.
34
38
:::
35
39
36
40
Once the command completes, you may need to restart your IDE for the changes to take effect.
@@ -39,6 +43,12 @@ Once the MCP Server is running, you can access the Defang MCP tools directly thr
39
43
40
44
That's it! Feel free to explore our [Example Prompts](#example-prompts) to get ideas on how to interact with the AI agent and make the most of the Defang MCP Server.
41
45
46
+
Note that we still support the previous client selection method using `--client=<your-ide>` flag, but it is not recommended.
47
+
48
+
```bash
49
+
defang mcp setup --client=<your-ide>
50
+
```
51
+
42
52
Note that `npx` installation is supported, but not recommended.
Select `cursor` from the [interactive prompt](#installation).
69
+
58
70
Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:
59
71
60
72

@@ -64,9 +76,15 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
64
76
Setup command:
65
77
66
78
```bash
67
-
defang mcp setup --client=windsurf
79
+
defang mcp setup
68
80
```
69
81
82
+
Select `windsurf` from the [interactive prompt](#installation).
83
+
84
+
:::warning
85
+
Windsurf currently does not support [MCP prompts](https://docs.windsurf.com/windsurf/cascade/mcp#general-information), therefore BYOC providers (AWS, GCP) cannot be set up through Windsurf. You can still use Playground as your deployment provider or setup AWS/GCP using the Defang CLI or another supported IDE.
86
+
:::
87
+
70
88
Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:
71
89
72
90

@@ -76,9 +94,11 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
76
94
Setup command:
77
95
78
96
```bash
79
-
defang mcp setup --client=vscode
97
+
defang mcp setup
80
98
```
81
99
100
+
Select `vscode` from the [interactive prompt](#installation).
101
+
82
102
Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:
83
103
84
104

@@ -88,9 +108,11 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
88
108
Setup command:
89
109
90
110
```bash
91
-
defang mcp setup --client=vscode-insiders
111
+
defang mcp setup
92
112
```
93
113
114
+
Select `vscode-insiders` from the [interactive prompt](#installation).
115
+
94
116
Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:
95
117
96
118

@@ -100,9 +122,11 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
100
122
Setup command:
101
123
102
124
```bash
103
-
defang mcp setup --client=kiro
125
+
defang mcp setup
104
126
```
105
127
128
+
Select `kiro` from the [interactive prompt](#installation).
129
+
106
130
Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:
107
131
108
132

@@ -114,9 +138,11 @@ While this is not an IDE in the traditional sense, it can support MCP servers. F
114
138
Setup command:
115
139
116
140
```bash
117
-
defang mcp setup --client=claude-desktop
141
+
defang mcp setup
118
142
```
119
143
144
+
Select `claude-desktop` from the [interactive prompt](#installation).
145
+
120
146
Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:
@@ -128,9 +154,11 @@ While this is not an IDE in the traditional sense, it can support MCP servers. F
128
154
Setup command:
129
155
130
156
```bash
131
-
defang mcp setup --client=claude-code
157
+
defang mcp setup
132
158
```
133
159
160
+
Select `claude-code` from the [interactive prompt](#installation).
161
+
134
162
Once setup is complete, you can interact with the AI coding agent using Defang-related actions like `check defang services` or [other prompts](#example-prompts). Here's an example of what it could look like:
0 commit comments