SKILL.md
readonlyread-only
name
api-connector-builder
description
Build a new API connector or provider by matching the target repo's existing integration pattern exactly. Use when adding one more integration without inventing a second architecture.
version
1.0.0
API 連接器建置工具
當任務是新增一個符合儲存庫原生風格的整合介面（而非單純的通用 HTTP 客戶端）時，請使用此工具。
重點在於比對主儲存庫的模式：
- 連接器佈局
- 設定結構
- 驗證模型
- 錯誤處理
- 測試風格
- 註冊/發現機制
使用時機
- 「為此專案建立一個 Jira 連接器」
- 「依照現有模式新增 Slack 提供者」
- 「為此 API 建立新的整合」
- 「建立一個符合儲存庫連接器風格的插件」
注意事項
- 若儲存庫已有整合架構，請勿發明新的架構
- 請勿僅從廠商文件開始；應先參考儲存庫內現有的連接器
- 若儲存庫預期包含註冊機制、測試與文件，請勿只完成傳輸層程式碼
- 若儲存庫已有更新的模式，請勿盲目複製舊連接器
工作流程
1. 學習內部風格
檢查至少 2 個現有的連接器/提供者，並記錄：
- 檔案佈局
- 抽象層邊界
- 設定模型
- 重試/分頁慣例
- 註冊鉤子
- 測試固定資料與命名方式
2. 縮小目標整合範圍
僅定義儲存庫實際需要的介面：
- 驗證流程
- 關鍵實體
- 核心讀寫操作
- 分頁與速率限制
- Webhook 或輪詢模型
3. 以儲存庫原生層級建置
典型層級：
- 設定/結構
- 客戶端/傳輸
- 對映層
- 連接器/提供者進入點
- 註冊
- 測試
4. 驗證是否符合原始模式
新的連接器在程式碼庫中應顯得自然，而非從不同生態系匯入。
參考結構
提供者風格
providers/
existing_provider/
__init__.py
provider.py
config.py
連接器風格
integrations/
existing/
client.py
models.py
connector.py
TypeScript 插件風格
src/integrations/
existing/
index.ts
client.ts
types.ts
test.ts
品質檢查清單
- [ ] 符合儲存庫內現有的整合模式
- [ ] 存在設定驗證
- [ ] 明確處理驗證與錯誤
- [ ] 分頁/重試行為遵循儲存庫規範
- [ ] 註冊/發現機制完整
- [ ] 測試反映主儲存庫的風格
- [ ] 若儲存庫預期有文件/範例，則已更新
相關技能
backend-patternsmcp-server-patternsgithub-ops
