Skip to content

Commit 61851dd

Browse files
committed
Upgrade readme with VS Code instructions
1 parent f32f302 commit 61851dd

File tree

1 file changed

+39
-38
lines changed

1 file changed

+39
-38
lines changed

README.md

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -10,62 +10,63 @@ An MCP server for managing and sharing your personal knowledge, daily notes, and
1010

1111
## 🏃 Getting started
1212

13-
> ℹ️ The GistPad MCP server is built using Node.js and so before you perform the following steps, you need to ensure that you've got Node.js already installed.
13+
1. Using VS Code?
1414

15-
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](<https://insiders.vscode.dev/redirect/mcp/install?name=gistpad&inputs=%5B%7B%22id%22:%22gistpad-token%22,%22type%22:%22promptString%22,%22description%22:%22GitHub%20Personal%20Access%20Token%20(GistPad)%22,%22password%22:true%7D%5D&config=%7B%22command%22:%22npx%22,%22args%22:%5B%22-y%22,%22gistpad-mcp%22%5D,%22env%22:%7B%22GITHUB_TOKEN%22:%22$%7Binput:gistpad-token%7D%22%7D%7D>) [![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](<https://insiders.vscode.dev/redirect/mcp/install?name=gistpad&inputs=%5B%7B%22id%22:%22gistpad-token%22,%22type%22:%22promptString%22,%22description%22:%22GitHub%20Personal%20Access%20Token%20(GistPad)%22,%22password%22:true%7D%5D&config=%7B%22command%22:%22npx%22,%22args%22:%5B%22-y%22,%22gistpad-mcp%22%5D,%22env%22:%7B%22GITHUB_TOKEN%22:%22$%7Binput:gistpad-token%7D%22%7D%7D&quality=insiders>)
15+
1. Simply install the [GistPad extension](https://aka.ms/gistpad) and sign-in with your GitHub account. After that, you can begin using GistPad from Copilot chat (in `Agent` mode) without doing any extra setup or token management 💪
1616

17-
1. Generate a personal access token that includes _only_ the `gist` scope: https://github.com/settings/tokens/new
17+
> _Note: This requires VS Code 1.101.0+, so if you're on an older version, it's time to upgrade!_
1818
19-
1. If you're using VS Code, then simply click the above badges to install the right config. Otherwise, add the equivalent of the following to your client's MCP config file (or via an "Add MCP server" GUI/TUI):
19+
1. Other MCP clients...
2020

21-
```json
22-
{
23-
"mcpServers": {
24-
"gistpad": {
25-
"command": "npx",
26-
"args": ["-y", "gistpad-mcp"],
27-
"env": {
28-
"GITHUB_TOKEN": "<YOUR_PAT>"
29-
}
30-
}
31-
}
32-
}
33-
```
21+
1. Generate a personal access token that includes _only_ the `gist` scope: https://github.com/settings/tokens/new
22+
1. Add the equivalent of the following to your client's MCP config file (or via an "Add MCP server" GUI/TUI):
3423

35-
1. Restart your MCP client _(optionally, depending on the tool)_
24+
```json
25+
{
26+
"mcpServers": {
27+
"gistpad": {
28+
"command": "npx",
29+
"args": ["-y", "gistpad-mcp"],
30+
"env": {
31+
"GITHUB_TOKEN": "<YOUR_PAT>"
32+
}
33+
}
34+
}
35+
}
36+
```
3637

37-
1. :partying_face: Start having fun with gists + MCP! For example, try things like...
38+
Once your client it setup, you can start having fun with gists + MCP! 🥳 For example, try things like...
3839

39-
1. **Exploring content**
40+
1. **Exploring content**
4041

41-
- `How many gists have I edited this month?`
42-
- `What's the summary of my <foo> gist?`
42+
- `How many gists have I edited this month?`
43+
- `What's the summary of my <foo> gist?`
4344

44-
1. **Creating content**
45+
1. **Creating content**
4546

46-
- `Create a new gist about <foo>`
47-
- `Update my <foo> gist to call out <bar>`
47+
- `Create a new gist about <foo>`
48+
- `Update my <foo> gist to call out <bar>`
4849

49-
1. **Daily todos**
50+
1. **Daily todos**
5051

51-
- `What are my unfinished todos for today?`
52-
- `Add a new todo for <foo>`
52+
- `What are my unfinished todos for today?`
53+
- `Add a new todo for <foo>`
5354

54-
1. **Collaboration**
55+
1. **Collaboration**
5556

56-
- `Add a comment to the <foo> gist saying <bar>`
57-
- `Give me a share URL for the <foo> gist`
58-
- `View my starred gists`
57+
- `Add a comment to the <foo> gist saying <bar>`
58+
- `Give me a share URL for the <foo> gist`
59+
- `View my starred gists`
5960

60-
1. **Gist organization**
61+
1. **Gist organization**
6162

62-
- `Archive my gist about <foo>`
63-
- `Add a new <foo> file to the <bar> gist and migrate the <baz> content into it`
63+
- `Archive my gist about <foo>`
64+
- `Add a new <foo> file to the <bar> gist and migrate the <baz> content into it`
6465

65-
1. **Reusable prompts**
66+
1. **Reusable prompts**
6667

67-
- `Create a new prompt that searches the web ofor a specified manga series and then provides a summary about it`
68-
- `Delete my prompt about <foo>`
68+
- `Create a new prompt that searches the web ofor a specified manga series and then provides a summary about it`
69+
- `Delete my prompt about <foo>`
6970

7071
## 🛠️ Included tools
7172

0 commit comments

Comments
 (0)