Skip to content

Commit 756eb99

Browse files
mbaiza27mbaiza27
and
mbaiza27
authored
Add VS Code installation instructions (#10)
Co-authored-by: mbaiza27 <[email protected]>
1 parent 0a3798f commit 756eb99

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

README.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,90 @@ export VECTORIZE_PIPELINE_ID=YOUR_PIPELINE_ID
1919
npx -y @vectorize-io/vectorize-mcp-server@latest
2020
```
2121

22+
### VS Code Installation
23+
24+
For one-click installation, click one of the install buttons below:
25+
26+
[![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=vectorize&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40vectorize-io%2Fvectorize-mcp-server%40latest%22%5D%2C%22env%22%3A%7B%22VECTORIZE_ORG_ID%22%3A%22%24%7Binput%3Aorg_id%7D%22%2C%22VECTORIZE_TOKEN%22%3A%22%24%7Binput%3Atoken%7D%22%2C%22VECTORIZE_PIPELINE_ID%22%3A%22%24%7Binput%3Apipeline_id%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22org_id%22%2C%22description%22%3A%22Vectorize+Organization+ID%22%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22token%22%2C%22description%22%3A%22Vectorize+Token%22%2C%22password%22%3Atrue%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22pipeline_id%22%2C%22description%22%3A%22Vectorize+Pipeline+ID%22%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=vectorize&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40vectorize-io%2Fvectorize-mcp-server%40latest%22%5D%2C%22env%22%3A%7B%22VECTORIZE_ORG_ID%22%3A%22%24%7Binput%3Aorg_id%7D%22%2C%22VECTORIZE_TOKEN%22%3A%22%24%7Binput%3Atoken%7D%22%2C%22VECTORIZE_PIPELINE_ID%22%3A%22%24%7Binput%3Apipeline_id%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22org_id%22%2C%22description%22%3A%22Vectorize+Organization+ID%22%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22token%22%2C%22description%22%3A%22Vectorize+Token%22%2C%22password%22%3Atrue%7D%2C%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22pipeline_id%22%2C%22description%22%3A%22Vectorize+Pipeline+ID%22%7D%5D&quality=insiders)
27+
28+
### Manual Installation
29+
30+
For the quickest installation, use the one-click install buttons at the top of this section.
31+
32+
To install manually, 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)`.
33+
34+
```json
35+
{
36+
"mcp": {
37+
"inputs": [
38+
{
39+
"type": "promptString",
40+
"id": "org_id",
41+
"description": "Vectorize Organization ID"
42+
},
43+
{
44+
"type": "promptString",
45+
"id": "token",
46+
"description": "Vectorize Token",
47+
"password": true
48+
},
49+
{
50+
"type": "promptString",
51+
"id": "pipeline_id",
52+
"description": "Vectorize Pipeline ID"
53+
}
54+
],
55+
"servers": {
56+
"vectorize": {
57+
"command": "npx",
58+
"args": ["-y", "@vectorize-io/vectorize-mcp-server@latest"],
59+
"env": {
60+
"VECTORIZE_ORG_ID": "${input:org_id}",
61+
"VECTORIZE_TOKEN": "${input:token}",
62+
"VECTORIZE_PIPELINE_ID": "${input:pipeline_id}"
63+
}
64+
}
65+
}
66+
}
67+
}
68+
```
69+
70+
Optionally, you can add the following to a file called `.vscode/mcp.json` in your workspace to share the configuration with others:
71+
72+
```json
73+
{
74+
"inputs": [
75+
{
76+
"type": "promptString",
77+
"id": "org_id",
78+
"description": "Vectorize Organization ID"
79+
},
80+
{
81+
"type": "promptString",
82+
"id": "token",
83+
"description": "Vectorize Token",
84+
"password": true
85+
},
86+
{
87+
"type": "promptString",
88+
"id": "pipeline_id",
89+
"description": "Vectorize Pipeline ID"
90+
}
91+
],
92+
"servers": {
93+
"vectorize": {
94+
"command": "npx",
95+
"args": ["-y", "@vectorize-io/vectorize-mcp-server@latest"],
96+
"env": {
97+
"VECTORIZE_ORG_ID": "${input:org_id}",
98+
"VECTORIZE_TOKEN": "${input:token}",
99+
"VECTORIZE_PIPELINE_ID": "${input:pipeline_id}"
100+
}
101+
}
102+
}
103+
}
104+
```
105+
22106
## Configuration on Claude/Windsurf/Cursor/Cline
23107

24108
```json

0 commit comments

Comments
 (0)