使用说明

项目简介

GistPad MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务，它利用 GitHub Gists 作为存储，帮助用户管理和共享个人知识、日常笔记、待办事项等。通过与支持 MCP 协议的客户端（如 GitHub Copilot、Claude Desktop 等）集成，用户可以使用自然语言与存储在 GitHub Gists 中的信息进行交互。

主要功能点

Gist 管理: 创建、读取、更新、删除和列出 GitHub Gists，方便用户管理知识片段和文档。
日常笔记: 支持创建和管理每日笔记，用于记录日常想法、待办事项和会议记录等。
文件操作: 允许用户在 Gist 中添加、删除、重命名和更新文件，灵活组织 Gist 内容。
星标和归档: 可以星标重要的 Gists，并归档不再活跃的 Gists，方便知识分类和管理。
评论功能: 支持对 Gists 添加、查看、编辑和删除评论，促进协作和知识交流。
资源访问: 将 Gists 作为 MCP 资源暴露，客户端可以直接读取 Gist 内容，无需调用工具，提高访问效率。

安装步骤

安装 Node.js: 确保您的计算机上已安装 Node.js 运行环境 (建议 v16 或更高版本)。您可以访问 Node.js 官网下载并安装。
生成 GitHub Personal Access Token: 访问 GitHub Personal Access Tokens 页面，创建一个新的 Personal Access Token。重要: Token 的 Scope (权限) 只需勾选 'gist' 即可。复制生成的 Token，稍后配置服务器时需要使用。

服务器配置

MCP 服务器需要在 MCP 客户端中配置才能使用。以下是 GistPad MCP 服务器的客户端配置示例 (JSON 格式)，您需要将此配置添加到您的 MCP 客户端的配置文件中。

{
  "mcpServers": {
    "gistpad": {
      "command": "npx",
      "args": ["-y", "gistpad-mcp"],
      "env": {
        "GITHUB_TOKEN": "<YOUR_PAT>"  // 将 "<YOUR_PAT>" 替换为您在安装步骤中生成的 GitHub Personal Access Token
      }
    }
  }
}

配置参数说明:

'"gistpad"': 服务器名称，您可以自定义，用于在 MCP 客户端中标识该服务器。
'"command": "npx"': 启动服务器的命令。'npx' 是 Node.js 的包执行器，用于运行安装在 npm 仓库中的包。
'"args": ["-y", "gistpad-mcp"]': 传递给 'npx' 的参数。
- '"-y"': 'npx' 的参数，表示自动确认安装 'gistpad-mcp' 包，无需用户手动确认。
- '"gistpad-mcp"': 要执行的 npm 包名称，即 GistPad MCP 服务器的包名。
'"env": { "GITHUB_TOKEN": "<YOUR_PAT>" }': 设置环境变量。
- '"GITHUB_TOKEN": "<YOUR_PAT>"': 设置名为 'GITHUB_TOKEN' 的环境变量，其值为您生成的 GitHub Personal Access Token。GistPad MCP 服务器需要此 Token 才能访问您的 GitHub Gists。

注意: 请将 '<YOUR_PAT>' 替换为您在安装步骤中生成的 GitHub Personal Access Token。不同的 MCP 客户端配置文件的位置和格式可能有所不同，请参考您的 MCP 客户端的文档进行配置。

基本使用方法

配置完成后，重启您的 MCP 客户端 (如果需要)。您就可以开始使用 GistPad MCP 服务器提供的功能了。以下是一些基本的使用示例，您可以直接在 MCP 客户端中输入这些指令与您的 Gists 进行交互：

查询本月更新了多少个 Gists？
今天有哪些未完成的待办事项？ (假设您使用 Daily Notes 记录待办事项)
创建一个关于 JavaScript 编程语言的新 Gist
归档关于 '<foo>' 的 Gist (将 '<foo>' 替换为您的 Gist 描述或关键词)
给我关于 '<bar>' 的 Gist 的分享链接 (将 '<bar>' 替换为您的 Gist 描述或关键词)

更多高级用法和工具列表，请参考仓库的 README 文档。

关键词