Skip to content

Commit 8eb0562

Browse files
committed
Add once click install link steps
1 parent e2dfa91 commit 8eb0562

File tree

1 file changed

+50
-2
lines changed

1 file changed

+50
-2
lines changed

docs/ide/mcp-servers.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,55 @@ You have multiple options to add an MCP server in Visual Studio:
8484

8585
With the latest servicing release of 17.14, Visual Studio now supports direct installation of MCP Servers. You can click the **Install** button on an MCP server to automatically add it to your Visual Studio instance.
8686

87-
To add a one-click install button to your MCP server repo, or if you notice one missing from a public server repo, you can create one using the protocol handler template
87+
To enable a one-click install button for any MCP server in Visual Studio:
88+
89+
1. Write your MCP server config in JSON.
90+
- **HTTP/SSE server example**
91+
92+
```json
93+
{"name":"My Server","type":"http","url":"https://example.com/mcp/"}
94+
```
95+
96+
- **stdio server example**
97+
98+
```json
99+
{"name":"My Server","type":"stdio","command":"python","args":["-m","my_mcp.server"]}
100+
```
101+
102+
Required fields:
103+
| **Field** | **Description** |
104+
|---------------------------|:--------------------:|
105+
| `name` | Friendly name for your server |
106+
| `type` | Server connection type, for example, "http" or "stdio" |
107+
| `url` | URL of the server, required for "http"|
108+
| `command` | Command to start the server executable, required for "stdio" |
109+
| `args` |Array of arguments passed to the command, required for "stdio" |
110+
111+
1. URL-encode the JSON, you can use an online encoder or your browser console.
112+
113+
Browser console example:
114+
115+
```js
116+
encodeURIComponent('{"name":"My Server","type":"http","url":"https://example.com/mcp/"}')
117+
```
118+
119+
1. Insert the URL-encoded JSON into the MCP URI format to form a Visual Studio install link.
120+
121+
Format:
122+
123+
```bash
124+
vsweb+mcp:/install?<ENCODED_JSON>
125+
```
126+
127+
1. Add the markdown badge to your GitHub repo/docs.
128+
129+
Example:
130+
131+
```markdown
132+
[![Install MCP Server in Visual Studio](https://img.shields.io/badge/Install%20in%20Visual%20Studio-blue?logo=visualstudio)](vsweb+mcp:/install?<ENCODED_JSON>)
133+
```
134+
135+
When a user clicks the badge, Visual Studio will launch (or prompt to open), and the MCP install dialog will appear, pre-filled with your server details.
88136

89137
### Add from chat view
90138

@@ -97,7 +145,7 @@ To add an MCP server in Visual Studio:
97145

98146
### Create a file to manage configuration of MCP servers
99147

100-
If you do not already have an `mcp.json` file, you can create it in various locations depending on the repos, users, and IDEs you would like the servers to be available/used for.
148+
If you do not already have an `mcp.json` file, create one in any of the supported locations based on your repository, user, or IDE requirements. To add an MCP server, locate the server’s JSON configuration online (for example, from the GitHub MCP servers repository) and paste it into your `mcp.json` file.
101149

102150
### File locations for automatic discovery of MCP configuration
103151

0 commit comments

Comments
 (0)