Skip to content

Commit 36b49bb

Browse files
mbaiza27mbaiza27colriot
authored
Add VS Code configure instructions (#25)
--------- Co-authored-by: mbaiza27 <mbaiza27@outllook.com> Co-authored-by: Sergey Ryabov <944361+colriot@users.noreply.github.com>
1 parent f8cc4e6 commit 36b49bb

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,66 @@ npm install -g agentql-mcp
4242

4343
Read more about MCP configuration in Claude [here](https://modelcontextprotocol.io/quickstart/user).
4444

45+
### Configure VS Code
46+
47+
For one-click installation, click one of the install buttons below:
48+
49+
[![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=agentql&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22agentql-mcp%22%5D%2C%22env%22%3A%7B%22AGENTQL_API_KEY%22%3A%22%24%7Binput%3AapiKey%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apiKey%22%2C%22description%22%3A%22AgentQL+API+Key%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=agentql&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22agentql-mcp%22%5D%2C%22env%22%3A%7B%22AGENTQL_API_KEY%22%3A%22%24%7Binput%3AapiKey%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apiKey%22%2C%22description%22%3A%22AgentQL+API+Key%22%2C%22password%22%3Atrue%7D%5D&quality=insiders)
50+
51+
#### Manual Installation
52+
53+
Click the install buttons at the top of this section for the quickest installation method. For manual installation, follow these steps:
54+
55+
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)`.
56+
57+
```json
58+
{
59+
"mcp": {
60+
"inputs": [
61+
{
62+
"type": "promptString",
63+
"id": "apiKey",
64+
"description": "AgentQL API Key",
65+
"password": true
66+
}
67+
],
68+
"servers": {
69+
"agentql": {
70+
"command": "npx",
71+
"args": ["-y", "agentql-mcp"],
72+
"env": {
73+
"AGENTQL_API_KEY": "${input:apiKey}"
74+
}
75+
}
76+
}
77+
}
78+
}
79+
```
80+
81+
Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others.
82+
83+
```json
84+
{
85+
"inputs": [
86+
{
87+
"type": "promptString",
88+
"id": "apiKey",
89+
"description": "AgentQL API Key",
90+
"password": true
91+
}
92+
],
93+
"servers": {
94+
"agentql": {
95+
"command": "npx",
96+
"args": ["-y", "agentql-mcp"],
97+
"env": {
98+
"AGENTQL_API_KEY": "${input:apiKey}"
99+
}
100+
}
101+
}
102+
}
103+
```
104+
45105
### Configure Cursor
46106

47107
- Open **Cursor Settings**

0 commit comments

Comments
 (0)