AI 程式設計教程中文版
官方教程中文版整合與 SDK

整合、API 與 SDK

整合、API 與 SDK相關的 Cursor 官方教程中文版。

當團隊已經有 issue、PR、工單、監控、內部平臺時,需要讓 Cursor 接收上下文、提交結果並納入許可權治理。這一組是 Cursor 的擴充套件層——Slack、GitHub、Linear、Admin API、Dashboard API、Marketplace 和 deeplinks 把 Cursor 接進外部系統。

閱讀方式:先看判斷和路徑,再進入具體章節。Cursor 的資料變化很快,模型、價格、用量和企業策略以官方頁面為準。

這組適合什麼時候讀

整合、API 與 SDK 層適合團隊已經有穩定開發流程之後再讀。它解決的是“Cursor 如何進入現有系統”,不是第一天入門問題。

典型場景:

  • 從 GitHub 或 GitLab PR 觸發任務。
  • 從 Slack 或 Linear 把討論變成可執行上下文。
  • 用 Admin API 或 Dashboard API 接入組織治理。
  • 用 SDK 或 deep links 把 Cursor 接進內部平臺。
  • 用 Marketplace 管理團隊擴充套件。

接入前檢查

任何整合都要先回答:

  • 誰可以觸發。
  • 觸發後能訪問哪些 repo、issue、PR 或訊息。
  • 結果回寫到哪裡。
  • 是否會建立任務、評論、提交或修改狀態。
  • 日誌、許可權和審計由誰負責。

如果這些問題沒答清楚,先不要上線到團隊空間。整合入口越方便,越容易把模糊討論直接變成大範圍任務。

SDK 和 deep links 適合把 Cursor 嵌進已有工具,但不應該繞開許可權治理。內部平臺觸發 Cursor 任務時,仍然要攜帶明確的 repo、branch、scope、validation 和 owner。否則只是把 prompt 表單換了一個入口。

官方能力邊界

按官方文件,幾個關鍵入口的職責不同:

入口官方定位使用邊界
GitHub app連線 repositories,支援 Cloud Agents 和 Bugbot需要配置 repo 訪問、PR、issues、checks、actions 等許可權
Slack在 Slack 中 mention @Cursor 啟動 Cloud Agent要寫清 repo、branch、model、autopr 等選項
TypeScript SDK透過 @cursor/sdk 從程式碼裡呼叫 Cursor Agentpublic beta,API 可能變化,適合指令碼和內部平臺
Deep Links分享 prompts、commands、rules開啟後需要使用者 review,不會自動執行

GitHub 企業環境還涉及 GHES 版本、入站訪問、webhook 出站、IP allow list、PrivateLink、Private Service Connect 或 reverse proxy tunnel。團隊接入前要把網路路徑和許可權面列清楚。

Slack 派發要寫清

官方 Slack 文件支援自然語言和 inline options,例如指定 repository、model、base branch、autopr=false。因此 Slack prompt 不應該只寫“修一下”,建議寫成:

@Cursor in backend-api branch=main autopr=false
请修复登录接口的 500 错误。
范围只限 auth service。
完成后跑对应测试,并在结果里说明是否需要开 PR。

Slack thread 可以提供上下文,但也可能混入噪音。涉及多個 agent 時,要區分“追加 follow-up”還是用 @Cursor agent 強制建立新 agent。

SDK 接入要控範圍

Cursor TypeScript SDK 用 @cursor/sdk 呼叫同一個 Agent,可以選擇 local runtime、Cursor-hosted cloud runtime 或 self-hosted cloud runtime。local 適合 dev scripts 和 CI against a working tree;cloud 適合呼叫方沒有 repo、需要並行 agent、或任務需要在呼叫方斷開後繼續執行;self-hosted pool 適合程式碼、secret、build artifacts 必須留在團隊環境裡的場景。

SDK 接入前要確認:

  • CURSOR_API_KEY 從安全環境注入,不寫進原始碼。
  • local runtime 的 cwd 是預期工作樹。
  • cloud runtime 的 repo、starting ref、auto PR 行為明確。
  • session env vars 只傳短期需要的憑據。
  • runs 的 stream、wait、cancel 和 artifact 下載都有日誌。

Deep Links 可以分享 prompt、command 和 rule。官方文件明確說明,使用者點選後需要 review 和確認,deeplink 不會自動執行。這一點很重要:它適合知識共享和團隊模板分發,不適合繞過審批直接觸發任務。

分享前要檢查:

  • prompt 裡沒有 API key、password、客戶資料或專有程式碼。
  • command 不會誤導使用者執行破壞性操作。
  • rule 不會擴大許可權或覆蓋團隊標準。
  • URL 長度沒有超過官方限制。

如果要真正自動化,應該走 CLI、Cloud Agent API 或 SDK,而不是依賴 deeplink。

驗收方式

整合上線前至少做一次 dry run:

  1. 用測試 repo 或低風險 issue 觸發。
  2. 確認觸發人、repo、branch、許可權和模型都符合預期。
  3. 檢查 Cursor 是否建立了預期任務或 PR。
  4. 檢查回寫位置:Slack thread、GitHub PR、Linear issue 或內部平臺。
  5. 檢查日誌、request ID、失敗提示和人工接管路徑。

這些驗收項透過後,再擴大到團隊頻道、生產 repo 或自動化入口。

官方來源

本頁目錄