Skip to content

Commit 5dd679c

Browse files
mbaiza27mbaiza27jirispilka
authored
add VS Code instructions to README (#62)
* Add vs code instructions --------- Co-authored-by: mbaiza27 <[email protected]> Co-authored-by: Jiří Spilka <[email protected]>
1 parent 3f27a38 commit 5dd679c

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ For example it can:
2727

2828
To interact with the Apify MCP server, you can use MCP clients such as:
2929
- [Claude Desktop](https://claude.ai/download) (only Stdio support)
30+
- [Visual Studio Code](https://code.visualstudio.com/) (Stdio and SSE support)
3031
- [LibreChat](https://www.librechat.ai/) (stdio and SSE support (yet without Authorization header))
3132
- [Apify Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-client) (SSE support with Authorization headers)
3233
- other clients at [https://modelcontextprotocol.io/clients](https://modelcontextprotocol.io/clients)
@@ -275,6 +276,63 @@ To configure Claude Desktop to work with the MCP server, follow these steps. For
275276
Find and analyze instagram profile of the Rock.
276277
```
277278
279+
#### VS Code
280+
281+
For one-click installation, click one of the install buttons below:
282+
283+
[![Install with NPX in VS Code](https://img.shields.io/badge/VS_Code-NPM-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=actors-mcp-server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40apify%2Factors-mcp-server%22%5D%2C%22env%22%3A%7B%22APIFY_TOKEN%22%3A%22%24%7Binput%3Aapify_token%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apify_token%22%2C%22description%22%3A%22Apify+API+Token%22%2C%22password%22%3Atrue%7D%5D) [![Install with NPX in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-NPM-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=actors-mcp-server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40apify%2Factors-mcp-server%22%5D%2C%22env%22%3A%7B%22APIFY_TOKEN%22%3A%22%24%7Binput%3Aapify_token%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apify_token%22%2C%22description%22%3A%22Apify+API+Token%22%2C%22password%22%3Atrue%7D%5D&quality=insiders)
284+
285+
##### Manual installation
286+
287+
You can manually install the Apify MCP Server in VS Code. First, click one of the install buttons at the top of this section for a one-click installation.
288+
289+
Alternatively, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.
290+
291+
```json
292+
{
293+
"mcp": {
294+
"inputs": [
295+
{
296+
"type": "promptString",
297+
"id": "apify_token",
298+
"description": "Apify API Token",
299+
"password": true
300+
}
301+
],
302+
"servers": {
303+
"actors-mcp-server": {
304+
"command": "npx",
305+
"args": ["-y", "@apify/actors-mcp-server"],
306+
"env": {
307+
"APIFY_TOKEN": "${input:apify_token}"
308+
}
309+
}
310+
}
311+
}
312+
}
313+
```
314+
315+
Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace - just omit the top-level `mcp {}` key. This will allow you to share the configuration with others.
316+
317+
If you want to specify which Actors to load, you can add the `--actors` argument:
318+
319+
```json
320+
{
321+
"servers": {
322+
"actors-mcp-server": {
323+
"command": "npx",
324+
"args": [
325+
"-y", "@apify/actors-mcp-server",
326+
"--actors", "lukaskrivka/google-maps-with-contact-details,apify/instagram-scraper"
327+
],
328+
"env": {
329+
"APIFY_TOKEN": "${input:apify_token}"
330+
}
331+
}
332+
}
333+
}
334+
```
335+
278336
#### Debugging NPM package @apify/actors-mcp-server with @modelcontextprotocol/inspector
279337

280338
To debug the server, use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) tool:

0 commit comments

Comments
 (0)