article
README
🚀 GitHub 星标项目 MCP 服务器
本项目是一个由 Cloudflare 提供支持的 MCP(模型上下文协议)服务器,可让您通过自然语言搜索和查询自己的 GitHub 星标仓库,极大提升信息检索效率。
🚀 快速开始
本项目可创建一个可搜索的数据库,用于存储您的 GitHub 星标仓库,具体步骤如下:
- 利用 GitHub API 获取所有星标的仓库。
- 提取并处理每个仓库的 README 文件。
- 将处理后的数据上传到 Cloudflare R2 存储。
- 使用 Cloudflare AutoRAG 创建嵌入以实现高效搜索。
- 暴露一个 MCP 服务器,支持通过自然语言查询这些仓库。
✨ 主要特性
- 自动获取并处理 GitHub 星标仓库,无需手动操作。
- 借助 GitHub Actions 实现每周更新,保证数据实时性。
- 存储仓库元数据和 README 内容,方便全面了解仓库信息。
- 提供语义搜索功能(通过 Cloudflare AutoRAG),精准定位所需仓库。
- 暴露兼容 MCP 的 API,便于与 AI 代理集成。
📦 安装指南
先决条件
- Node.js(推荐版本 v22)
- PNPM 包管理器
- 具备
repo权限的 GitHub 个人访问令牌 - Cloudflare 账户
配置步骤
- 克隆此仓库。
- 设置 Cloudflare R2:
- 创建一个 R2 存储桶。
- 配置 R2 访问凭证。
- 配置 GitHub 秘密用于 CI/CD 工作流:
GH_TOKEN:GitHub 令牌,用于获取星标仓库。R2_ACCOUNT_ID:Cloudflare 账户 ID。R2_ACCESS_KEY_ID:R2 访问密钥。R2_SECRET_ACCESS_KEY:R2 秘密密钥。R2_BUCKET:R2 存储桶名称。
- 配置 Cloudflare AutoRAG:
- 在 Cloudflare 上创建一个 AutoRAG 实例。
- 设置 Cloudflare Worker 环境变量
AUTO_RAG_NAME。
本地开发
要进行本地开发,可按以下步骤操作:
# 安装依赖
pnpm install
# 本地获取您的 GitHub 星标仓库
pnpm dev:stars
# 启动 MCP 服务器(本地)
pnpm dev:mcp
部署
部署到 Cloudflare Workers:
pnpm deploy
GitHub Actions 将自动执行以下操作:
- 每周运行一次以更新星标仓库。
- 将处理后的文件上传到 R2。
- 重建 AutoRAG 索引。
💻 使用示例
部署完成后,您可以使用任何 MCP 兼容客户端与 MCP 服务器交互:
SSE:https://your-worker-url.workers.dev
📚 详细文档
MCP 工具:search_github_stars
通过自然语言搜索您的 GitHub 星标仓库。
参数
query(字符串):用于搜索的自然语言查询
响应
- 包含匹配仓库和相关 README 内容的 JSON 结果
微信扫一扫