GitHub Stars MCP Server

使用说明内容(Markdown格式)

  • 项目简介

    • 该仓库实现了一个 MCP 服务器,基于 MCP 规范向 LLM 客户端提供对 GitHub 收藏仓库的查询能力。服务器通过注册工具(如 search_github_stars)来暴露功能,使用 Cloudflare AutoRAG 进行语义搜索,并通过 JSON-RPC 形式与客户端通信。服务器具备简单的认证机制,保护接口。
  • 主要功能点

    • MCP 服务端实现:提供 MCP 风格的请求处理、工具注册、响应返回等核心能力。
    • 工具注册与执行:通过 init() 注册 search_github_stars 工具,接受查询参数并返回结构化内容。
    • 数据源与索引:依赖 GitHub 的星标仓库数据,通过 AutoRAG 进行向量化检索以实现高质量的自然语言查询结果。
    • 安全性:通过 MCP_API_KEY 进行请求鉴权。
    • 部署与运行:代码可部署到 Cloudflare Workers,提供一个可上线的 MCP 服务端。
  • 安装步骤

    • 硬件/环境要求
      • Node.js(建议版本 22)
      • PNPM 包管理器
    • 获取代码并安装依赖
      • 克隆仓库并进入项目目录
      • 运行依赖安装命令(如 pnpm install)
    • 数据准备与凭证
      • 设置 GitHub 令牌(GH_TOKEN),用于拉取你在 GitHub 的星标仓库
      • 配置 Cloudflare R2、AutoRAG、以及 Cloudflare Worker 相关凭证
    • 本地开发与运行
      • 获取星标数据并准备 README 内容的脚本(实现于 scripts/index.js)
      • 本地启动 MCP 服务:执行 README 提到的命令 pnpm dev:mcp
    • 部署
      • 将代码部署到 Cloudflare Workers,部署命令通常为 pnpm deploy,具体请参考仓库的部署指引
  • 服务器配置(MCP 客户端使用的连接配置,示例信息为 JSON 格式,便于理解参数含义)

    • server name: GitHub Stars MCP Server
    • command: 提交 MCP 服务端启动命令的主命令
    • args: 启动参数列表 说明:以下信息仅供 MCP 客户端了解如何连接和启动服务,不属于需要执行的代码。实际连接需要通过 HTTP(S) endpoint,并在请求头中提供 API key。 { "server_name": "GitHub Stars MCP Server", "command": "pnpm", "args": ["dev:mcp"] }
    • 连接细节(简要说明)
      • 端点:Cloudflare Worker 提供的工作流地址,例如 https://your-worker-url.workers.dev
      • 认证:请求头中需包含 Authorization: Bearer <你的 MCP_API_KEY>
      • 功能入口:通过 MCP 客户端调用 tool 'search_github_stars',传入 query 参数即可触发语义查询
      • 依赖环境变量(客户端不需要,服务器端使用)
        • MCP_API_KEY:用于鉴权
        • AUTO_RAG_NAME:AutoRAG 实例名称
        • GITHUB_TOKEN、R2 等凭证用于数据准备与索引构建(在服务器端或工作流中配置)
  • 基本使用方法

    • 第一步:确保服务器已正确部署并暴露端点
    • 第二步:在 MCP 客户端中配置服务器链接信息(如上述 JSON 配置描述),并使用 API Key 进行鉴权
    • 第三步:发送工具调用请求,例如调用 search_github_stars,传入 query 参数,获取返回内容并进行后续处理

服务器信息