使用说明
📓 GistPad MCP
MCP服务器,用于通过GitHub Gists管理和共享您的个人知识、日常笔记和可重复使用的提示。它是GistPad的伴侣 VS代码扩展 和 GistPad.dev (适用于网络/移动设备),它允许您从任何支持MCP的AI产品(例如GitHub Copilot、Claude Desktop)访问和编辑您的注册表。
🏃 入门
-
使用VS代码?
-
安装 GistPad扩展 然后重新加载VS代码
注意:这需要VS Code 1.101.0+,所以如果你使用的是旧版本,是时候升级了!
-
打开
GistPad标签并使用您的GitHub帐户登录。之后,您可以从Copilot聊天开始使用GistPad(在Agent模式),无需进行任何额外的设置或令牌管理💪
-
-
其他MCP客户端。..
-
生成一个个人访问令牌,其中包括 仅 这
gist范围:https://github.com/settings/tokens/new -
将以下等效内容添加到客户端的MCP配置文件中(或通过“添加MCP服务器”GUI/TUI):
{ "mcpServers": { "gistpad": { "command": "npx", "args": ["-y", "gistpad-mcp"], "env": { "GITHUB_TOKEN": "<YOUR_PAT>" } } } }
-
一旦你的客户端设置好了,你就可以开始享受gists+MCP的乐趣了! 🥳 例如,尝试类似的事情。..
-
探索内容
How many gists have I edited this month?What's the summary of my <foo> gist?
-
创建内容
Create a new gist about <foo>Update my <foo> gist to call out <bar>
-
每日所有
What are my unfinished todos for today?Add a new todo for <foo>
-
协作
Add a comment to the <foo> gist saying <bar>Give me a share URL for the <foo> gistView my starred gists
-
Gist组织
Archive my gist about <foo>Add a new <foo> file to the <bar> gist and migrate the <baz> content into it
-
可重用提示
Create a new prompt that searches the web ofor a specified manga series and then provides a summary about itDelete my prompt about <foo>
🛠️ 包含的工具
Gist管理
list_gists-列出您的所有注册表(不包括每日笔记和存档注册表)。get_gist-按ID获取要点的内容。create_gist-使用指定的描述和初始文件内容创建新的要点。delete_gist-按ID删除要点。update_gist_description-按ID更新要点描述。duplicate_gist-创建现有要点及其所有文件的副本。refresh_gists-重新加载要点列表,忽略任何缓存数据。
文件管理
update_gist_file-更新要点中特定文件的内容。add_gist_file-将新文件添加到现有要点中。delete_gist_file-从要点中删除文件。rename_gist_file-重命名要点中的现有文件。edit_gist_file-对要点文件进行有针对性的查找和替换编辑。
评论
list_gist_comments-列出指定要点的所有评论。add_gist_comment-在要点中添加新注释。edit_gist_comment-更新现有评论的内容。delete_gist_comment-从要点中删除注释。
🛠️ 可选工具
默认情况下,禁用以下工具集以保持工具曲面最小。通过传递相应的CLI标志来启用它们。
每日笔记(--daily)
get_todays_note-获取或创建今天的每日笔记。update_todays_note-更新今天的每日笔记内容。list_daily_notes-列出你所有的日常笔记。get_daily_note-按日期获取特定日记的内容。delete_daily_note-按日期删除特定的日记。
主演(--starred)
list_starred_gists-列出你所有的明星注册表。star_gist-按ID标出具体要点。unstar_gist-通过ID取消明星要点。
归档(--archived)
list_archived_gists-列出所有存档的注册表。archive_gist-把你的一个注册表存档。unarchive_gist-整理归档的要点。
提示(--prompts)
list_gist_prompts-列出提示集合中的提示。add_gist_prompt-在提示集合中添加新提示。delete_gist_prompt-从集合中删除提示。
📁 包括的资源
除了上述工具外,GistPad MCP服务器还将您的gist作为资源公开(使用 gist:/// URI方案),这允许客户端在不需要执行工具的情况下读取它们。
当您添加/删除/复制要点或更改要点的描述时,将向MCP客户端提供通知,指示资源列表已更改。如果您的MCP客户端支持资源订阅,那么您可以订阅特定的要点,并在更新时收到通知。
此外,对于支持资源模板的MCP客户端,GistPad还公开了一个资源 gist:///{gistId}/comments,它允许查询注释以获取要点(无需执行 list_gist_comments 工具)。
资源配置
如果您想将存档的注册表、带星号的注册表和/或每日笔记作为资源公开,那么只需更新MCP服务器配置即可通过 --archived, --starred和/或 --daily 旗帜到 gistpad-mcp CLI。
💬 可重用提示
GistPad允许您创建和管理作为markdown文件存储在gist中的参数化/可重用提示。您可以使用管理提示 add_prompt 和 delete_prompt 工具,只需要求您的MCP客户端创建/删除一个带有您想要的指定内容/参数的提示即可。
在幕后,提示以markdown文件的形式存储在名为 💬 Prompts (由自动创建) add_prompt 工具)。提示文件包括作为正文的提示,以及可选的使用前体的描述和参数。如果提示使用了参数,提示正文应包括 {{argument}} 占位符,当MCP客户端检索占位符时,占位符将被替换。
💻 CLI 参考
这 gistpad-mcp CLI接受以下可选标志:
--archived-启用归档工具并将归档的注册表包含在资源中--starred-启用星级工具并在资源中包含星级注册表--daily-启用每日笔记工具,并在资源中包含每日笔记--prompts-启用提示工具和MCP提示处理程序--markdown-仅过滤由Markdown文件组成的注册表
🧰 故障排除
- 在你的列表中没有看到要点? GistPad MCP服务器缓存您的要点列表,并在1)您通过MCP服务器进行更改时随时更新,或2)每小时更新一次。但是,如果您使用外部客户端添加/编辑/删除要点,您可能需要告诉GistPad MCP自行刷新(假设它还没有执行每小时刷新)。您可以通过触发
refresh_gists工具(例如运行#refresh_gists在VS Code Copilot聊天中)。
