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
+54-6Lines changed: 54 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -114,25 +114,39 @@ While this is not an IDE in the traditional sense, it can support MCP servers. F
114
114
Setup command:
115
115
116
116
```bash
117
-
defang mcp setup --client=claude
117
+
defang mcp setup --client=claude-desktop
118
118
```
119
119
120
120
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:
While this is not an IDE in the traditional sense, it can support MCP servers. For a smoother experience, consider specifying a project name or directory when making chat prompts to this platform.
127
+
128
+
Setup command:
129
+
130
+
```bash
131
+
defang mcp setup --client=claude-code
132
+
```
133
+
134
+
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:
135
+
136
+

123
137
124
138
## MCP Tools
125
139
126
140
Below are the tools available in the Defang MCP Server.
127
141
142
+
:::info[Prerequisite]
143
+
In order to use any of the MCP tools, you must set a provider using one of the [MCP prompts](#mcp-prompts) first.
144
+
:::
145
+
128
146
### `deploy`
129
147
130
148
The `deploy` tool scans your project directory for Dockerfiles and `compose.yaml` files, then deploys the detected service(s) using Defang. You can monitor the deployment process in the Defang Portal.
131
149
132
-
:::info
133
-
The Defang MCP Server currently supports deployments to [Defang Playground](/docs/providers/playground). We plan to support BYOC in future updates.
134
-
:::
135
-
136
150
### `services`
137
151
138
152
The `services` tool displays the details of all your services that are currently deployed in your project with Defang. It shows the Service Name, Deployment ID, Public URL and Service Status. If there are no services found, it will display an appropriate message.
@@ -157,6 +171,40 @@ The `set_config` tool will [set](/docs/tutorials/configure-environment-variables
157
171
158
172
The `remove_config` tool will [remove](/docs/tutorials/configure-environment-variables#removing-a-config-value) a specific Defang config for your project.
159
173
174
+
## MCP Prompts
175
+
176
+
Below are the [prompts](https://modelcontextprotocol.io/specification/2025-06-18/server/prompts) available in the Defang MCP Server.
177
+
178
+
### `defang.AWS_Setup`
179
+
180
+
The `defang.AWS_Setup` prompt helps you set up your AWS credentials for deploying services to AWS using Defang. Please read this [guide](../tutorials/deploying-with-the-defang-mcp-server#aws) on how to use this prompt.
181
+
182
+
:::note
183
+
Credentials never leave memory and are automatically cleared after you close your IDE.
184
+
:::
185
+
186
+
Arguments:
187
+
188
+
- AWS Credential - REQUIRED : Will take a profile name if using an AWS profile, or an Access Key ID if using Access Keys.
189
+
- AWS_SECRET_ACCESS_KEY - REQUIRED for Access Keys method: Leave blank if using an AWS profile.
190
+
- AWS_REGION - REQUIRED or OPTIONAL : Required if using Access Keys method, optional if using an AWS profile.
191
+
192
+
### `defang.GCP_Setup`
193
+
194
+
The `defang.GCP_Setup` prompt helps you set up your targeted GCP project for deploying services to GCP using Defang. Please read this [guide](../tutorials/deploying-with-the-defang-mcp-server#gcp) on how to use this prompt.
195
+
196
+
Arguments:
197
+
198
+
- GCP Project ID - REQUIRED : The ID of the GCP project you want to use (e.g., "my-gcp-project").
199
+
200
+
### `defang.Playground_Setup`
201
+
202
+
The `defang.Playground_Setup` prompt helps you set up Defang Playground as your deployment provider. Please read this [guide](../tutorials/deploying-with-the-defang-mcp-server#playground) on how to use this prompt.
203
+
204
+
Arguments:
205
+
206
+
- No arguments required
207
+
160
208
## Example Prompts
161
209
162
210
After connecting the Defang MCP Server to your IDE using an installation method, you can type in prompts in your chat to invoke the AI agent to use any MCP tool(s).
0 commit comments