Skip to content

Commit 70082e8

Browse files
Merge pull request #214 from DefangLabs/Prakash-Sundaresan-patch-2
Update mcp.md
2 parents 5f119f8 + ae73aef commit 70082e8

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

docs/concepts/mcp.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
---
2-
title: MCP
3-
description: Model Context Protocol (MCP) server with built-in tools to allow users to deploy with Defang through a supported IDE.
2+
title: MCP Server
3+
description: Model Context Protocol (MCP) Server with built-in tools to allow users to deploy with Defang through a supported IDE.
44
sidebar-position: 200
55
---
66

7-
# Model Context Protocol (MCP)
7+
# Model Context Protocol (MCP) Server
88

9-
The Defang [Model Context Protocol (MCP) server](https://github.com/DefangLabs/defang/tree/main/src/pkg/mcp) includes built-in tools to allow users to deploy and manage cloud services through a supported IDE.
9+
The Defang [Model Context Protocol (MCP) Server](https://github.com/DefangLabs/defang/tree/main/src/pkg/mcp) includes built-in tools to allow users to deploy and manage cloud services through a supported IDE.
1010

11-
Using this MCP server with an IDE will enable the AI coding agent (e.g. Copilot) to use Defang tools and resources to perform tasks, such as deploying a service to the cloud. This means you can now use Defang with IDE-integrated AI coding agents.
11+
Using this MCP Server with an IDE will enable the AI coding agent (e.g. Copilot) to use Defang tools and resources to perform tasks, such as deploying a service to the cloud. This means you can now use Defang with IDE-integrated AI coding agents.
1212

1313
![Defang MCP Server Diagram](/img/mcp-concept/diagram.png)
1414

1515
For more details about MCP architecture, visit the [official MCP documentation](https://modelcontextprotocol.io/introduction).
1616

1717
:::info
18-
The MCP Server currently supports deployments to [Defang Playground](/docs/providers/playground). We plan to support Defang BYOC in future updates.
18+
This page is a guide to the Defang MCP Server detailing its installation, tools, and usage. If you are looking for an example of how you can deploy a MCP project with Defang, please instead refer to our [MCP sample application](https://github.com/DefangLabs/samples/tree/main/samples/mcp).
1919
:::
2020

2121
## Installation
2222

2323
First, make sure you have the [npm package manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed so that you can use `npx` commands.
2424

25-
Connect the MCP server with your IDE by running the following command in your terminal:
25+
Connect the Defang MCP Server with your IDE by running the following command in your terminal:
2626

2727
```bash
2828
npx -y defang mcp setup --client=<your-ide>
2929
```
3030

31-
Replace `<your-ide>` with the name of your preferred IDE. See our list of [Supported IDEs](#supported-ides). After setup, you can start the MCP server with the command:
31+
Replace `<your-ide>` with the name of your preferred IDE. See our list of [Supported IDEs](#supported-ides). After setup, you can start the MCP Server with the command:
3232

3333
```bash
3434
npx -y defang mcp serve
3535
```
3636

37-
Once the server is running, you can access the Defang MCP tools directly through the AI agent chat in your IDE.
37+
Once the MCP Server is running, you can access the Defang MCP tools directly through the AI agent chat in your IDE.
3838

3939
![IDE Screenshot](/img/mcp-concept/ide.png)
4040

@@ -54,7 +54,7 @@ npx -y defang mcp setup --client=cursor
5454
npx -y defang mcp setup --client=windsurf
5555
```
5656

57-
### VSCode
57+
### VS Code
5858

5959
```bash
6060
npx -y defang mcp setup --client=vscode
@@ -77,7 +77,7 @@ Below are the tools available in the Defang MCP Server.
7777
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.
7878

7979
:::info
80-
The MCP Server currently supports deployments to [Defang Playground](/docs/providers/playground). We plan to support Defang BYOC in future updates.
80+
The Defang MCP Server currently supports deployments to [Defang Playground](/docs/providers/playground). We plan to support BYOC in future updates.
8181
:::
8282

8383
### `services`
@@ -88,10 +88,6 @@ The `services` tool displays the details of all your services that are currently
8888

8989
Given a project name or directory, the `destroy` tool identifies any services deployed with Defang and terminates them. If no services are found, it will display an appropriate message.
9090

91-
:::info
92-
This page is a guide to the Defang MCP Server detailing its installation, tools, and usage. If you are looking for an example of how you can deploy a MCP project with Defang, please instead refer to our [MCP sample application](https://github.com/DefangLabs/samples/tree/main/samples/mcp).
93-
:::
94-
9591
## Example Prompts
9692

9793
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

Comments
 (0)