Created
March 31, 2025 19:55
-
-
Save burkeholland/90ec39cc8e8a42eac8a46e601879f0e6 to your computer and use it in GitHub Desktop.
vscode-install-instructions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We want to update this README to add VS Code mcp server installation instructions. We want to add the one-click install buttons to the top of the README. The buttons should only be at the top of the README and nowhere else in the file. There is no need to indicate that these buttons are external links. | |
Here is an example of how the buttons are formed... | |
``` | |
[](https://vscode.dev/redirect?url=vscode:mcp/install?%7B%22name%22%3A%22everart%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40modelcontextprotocol%2Fserver-everart%22%5D%2C%22env%22%3A%7B%22EVERART_API_KEY%22%3A%22%24%7Binput%3Aeverart_api_key%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22everart_api_key%22%2C%22description%22%3A%22EverArt%20API%20Key%22%2C%22password%22%3Atrue%7D%5D%7D) [](https://insiders.vscode.dev/redirect?url=vscode-insiders:mcp/install?%7B%22name%22%3A%22everart%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40modelcontextprotocol%2Fserver-everart%22%5D%2C%22env%22%3A%7B%22EVERART_API_KEY%22%3A%22%24%7Binput%3Aeverart_api_key%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22everart_api_key%22%2C%22description%22%3A%22EverArt%20API%20Key%22%2C%22password%22%3Atrue%7D%5D%7D) | |
[](https://vscode.dev/redirect?url=vscode:mcp/install?%7B%22name%22%3A%22everart%22%2C%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22EVERART_API_KEY%22%2C%22mcp%2Feverart%22%5D%2C%22env%22%3A%7B%22EVERART_API_KEY%22%3A%22%24%7Binput%3Aeverart_api_key%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22everart_api_key%22%2C%22description%22%3A%22EverArt%20API%20Key%22%2C%22password%22%3Atrue%7D%5D%7D) [](https://insiders.vscode.dev/redirect?url=vscode-insiders:mcp/install?%7B%22name%22%3A%22everart%22%2C%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22EVERART_API_KEY%22%2C%22mcp%2Feverart%22%5D%2C%22env%22%3A%7B%22EVERART_API_KEY%22%3A%22%24%7Binput%3Aeverart_api_key%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22everart_api_key%22%2C%22description%22%3A%22EverArt%20API%20Key%22%2C%22password%22%3Atrue%7D%5D%7D) | |
``` | |
We want to add manual instructions in the appropriate section in the body. Look for sections that contain Cursor, Claude Desktop or other tools. If you aren't sure where to put the manual instructions, ask the user for clarification. | |
We want to remind the user that they can click the install buttons at the top of the file as the first step in the installation instrucxtions. Do not repeat the buttons here, just tell the user to go to the top of the file. | |
Make sure that the manual instructions are not the last thing in the file. Look for the most appropriate place to add them and try to copy any existing styles used by other tools/IDE configuration instructions. | |
For manual installation, we want to tell the user how to open their user settings (json) and then give them the JSON they need to add to that file. | |
We also want to provide the CLI command for manual installation. For the CLI command, we want commands for both Stable and Insiders. | |
Here is an example of a well-formed CLI command... | |
``` | |
code --add-mcp '{"name":"tavily","command":"python","args":["-m","mcp_server_tavily"],"env":{"TAVILY_API_KEY":"${input:tavily_api_key}"},"inputs":[{"id":"tavily_api_key","description":"Tavily API Key","password":true}]}' | |
``` | |
``` | |
code-insiders --add-mcp '{"name":"tavily","command":"python","args":["-m","mcp_server_tavily"],"env":{"TAVILY_API_KEY":"${input:tavily_api_key}"},"inputs":[{"id":"tavily_api_key","description":"Tavily API Key","password":true}]}' | |
``` | |
Avoid deleting or altering any existing code in the file. You can add code for installation instructions, but you should leave existing code and content as you found it. | |
Here is an example of a well formed JSON block for an MCP server in VS Code... | |
```json | |
{ | |
"everart": { | |
"inputs": [ | |
{ | |
"id": "everart_api_key", | |
"description": "EverArt API Key", | |
"password": true | |
} | |
], | |
"command": "npx", | |
"args": ["-y", "@modelcontextprotocol/server-everart"], | |
"env": { | |
"EVERART_API_KEY": "${input:everart_api_key}" | |
} | |
} | |
} | |
``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment