MCP Cli Github Integration

🚀 GitHub集成中心

GitHub集成中心由Cristian构建，用于展示OAuth编排、安全令牌存储、SDK/CLI工具以及MCP服务器，采用TypeScript编写。该项目旨在提供一个全面的解决方案，帮助开发者实现与GitHub的集成，同时展示了在Node.js环境下使用Express、better-sqlite3和TypeScript进行开发的最佳实践。

🚀 快速开始

安装依赖

npm install

配置环境

将 .env.example 复制为 .env，并设置你的GitHub OAuth凭证：

PORT=3000
DATABASE_FILE=./github-integration-hub.db
GITHUB_CLIENT_ID=your-client-id
GITHUB_CLIENT_SECRET=your-client-secret
GITHUB_OAUTH_AUTHORIZE_URL=https://github.com/login/oauth/authorize
GITHUB_OAUTH_TOKEN_URL=https://github.com/login/oauth/access_token
GITHUB_API_BASE_URL=https://api.github.com
GITHUB_REDIRECT_URI=http://localhost:3000/auth/github/callback
GITHUB_INTEGRATION_HUB_BASE_URL=http://localhost:3000

⚠️ 重要提示

请确保GitHub OAuth应用的重定向URL与 GITHUB_REDIRECT_URI 匹配。

运行后端

开发模式（热重载）：

npm run dev

生产模式（构建并运行）：

npm run build
npm start

服务器日志将显示：GitHub Integration Hub listening on port <port>。

✨ 主要特性

• OAuth认证：/auth/github/start 和 /auth/github/callback 封装了GitHub的OAuth认证流程。
• 数据存储：自动创建SQLite表，提供刷新脚手架和仓库助手。
• 服务编排：HTTP路由、CLI、SDK和MCP工具共享编排逻辑。
• 工具支持：提供类型安全的 IntegrationHubClient SDK和 github-integration-hub CLI。
• AI代理支持：MCP工具 github_start_auth、github_list_repos 和 github_create_issue 支持AI代理。

📦 安装指南

1. 安装依赖

npm install

2. 配置环境

复制 .env.example 到 .env，并设置GitHub OAuth凭证。

3. 运行后端

开发模式：

npm run dev

生产模式：

npm run build
npm start

💻 使用示例

基础用法

import { IntegrationHubClient } from 'github-integration-hub/sdk';

const client = new IntegrationHubClient({ baseUrl: process.env.GITHUB_INTEGRATION_HUB_BASE_URL! });

async function showcase() {
  const { authUrl } = await client.startGithubAuth('user-123');
  console.log('Send someone to authorize:', authUrl);

  const repos = await client.listGithubRepos('user-123');
  console.log(repos.map((repo) => repo.full_name));
}

高级用法

npm run build
npx github-integration-hub connections:list
npx github-integration-hub actions:list-repos --user alice
npx github-integration-hub actions:create-issue --user alice --owner my-org --repo api --title "Hello" --body "Proof from Cristian"

命令行参数说明

• --base-url：覆盖 GITHUB_INTEGRATION_HUB_BASE_URL。
• connections:list --user <userId>：过滤连接列表。

📚 详细文档

MCP服务器（用于AI代理）

编译一次，然后启动stdio服务器：

npm run build
npm run start:mcp

可用工具：

• github_start_auth：返回 userId 的授权URL。
• github_list_repos：列出存储连接的仓库。
• github_create_issue：使用保存的令牌创建问题。

将支持MCP的IDE/CLI（如Codex）指向此stdio进程，即可立即调用这些工具。

HTTP API参考

手动OAuth测试计划

1. POST /auth/github/start 并传入 { "userId": "demo-user" }。
2. 访问返回的 authUrl，批准GitHub应用。
3. 回调会自动存储连接。
4. 使用HTTP、CLI、SDK或MCP工具触发操作。

🔧 技术细节

项目结构

.
|-- cli/               # CLI入口点
|-- sdk/               # TypeScript SDK
|-- src/
|   |-- config/        # 环境助手
|   |-- db/            # SQLite初始化 + 仓库
|   |-- mcp/           # MCP服务器
|   |-- providers/     # GitHub OAuth + API客户端
|   |-- routes/        # Express路由器
|   `-- services/      # 令牌管理器 + 操作
|-- .env.example
|-- package.json
|-- tsconfig.json
`-- README.md

作者：Cristian。如果你想讨论后端集成、OAuth设计或MCP工具，请随时联系我。