返回 MCP 目录
public公开dns本地运行

github-oauth-mcp

一个演示如何实现GitHub OAuth认证的最小化MCP服务器项目,包含GitHub应用注册和测试指南。

article

README

🚀 最小的 GitHub OAuth 启用 MCP 服务器

本项目是一个最小示例,展示了如何在 MCP 服务器中实现 GitHub OAuth,帮助你快速了解相关实现方式。

⚠️ 重要提示

此仓库已存档。请参考 参考资料集合 获取最新示例和最佳实践。

⚠️ 重要警告

此实现不适合生产环境使用。如果打算采用其中的任何实践,请确保实施适当的缓存和安全的令牌/凭据处理措施。

🚀 快速开始

✨ 主要特性

本项目主要特性为展示在 MCP 服务器中实现 GitHub OAuth 的最小示例,帮助开发者快速了解实现流程。

📦 安装指南

GitHub 应用注册

在使用此 MCP 服务器之前,请确保您有一个可用于测试的 GitHub 应用。您可以在 您的 GitHub 设置 中注册一个新应用。

在 GitHub 上注册新应用

一旦应用程序已注册,请确保生成一个新的秘密。

为 GitHub 应用生成新的秘密

准备好客户端 ID 和秘密后,在项目根目录下创建一个新的 .env 文件,并添加:

GITHUB_CLIENT_ID=您的客户端 ID
GITHUB_CLIENT_SECRET=您的秘密

运行服务器

npm install
npm run build
npm run start

💻 使用示例

测试

您需要使用 MCP Inspector 或其他支持 HTTP+SSE 传输的 MCP 服务器和身份验证工具。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端