Skip to content

Commit aaeed0d

Browse files
committed
added prompts to mcp file
1 parent 7c5cd62 commit aaeed0d

File tree

2 files changed

+42
-4
lines changed

2 files changed

+42
-4
lines changed

docs/concepts/mcp.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,14 @@ Once setup is complete, you can interact with the AI coding agent using Defang-r
139139

140140
Below are the tools available in the Defang MCP Server.
141141

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+
142146
### `deploy`
143147

144148
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.
145149

146-
:::info
147-
The Defang MCP Server currently supports deployments to [Defang Playground](/docs/providers/playground). We plan to support BYOC in future updates.
148-
:::
149-
150150
### `services`
151151

152152
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.
@@ -171,6 +171,40 @@ The `set_config` tool will [set](/docs/tutorials/configure-environment-variables
171171

172172
The `remove_config` tool will [remove](/docs/tutorials/configure-environment-variables#removing-a-config-value) a specific Defang config for your project.
173173

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+
174208
## Example Prompts
175209

176210
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).

docs/tutorials/deploying-with-the-defang-mcp-server.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ Open your chat window and type `/defang.AWS_Setup`, or select the corresponding
3333

3434
The [MCP prompt](https://modelcontextprotocol.io/specification/2025-06-18/server/prompts) accepts two types of credentials:
3535

36+
:::note
37+
Credentials never leave memory and are automatically cleared after you close your IDE.
38+
:::
39+
3640
1. Method 1 - Using an AWS Profile:
3741
The following prompt will have three arguments and only the first argument is required:
3842

0 commit comments

Comments
 (0)