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工具，請隨時聯繫我。