Cursor SDKの導入

目次

Cursor SDKとは?

Cursor SDK は、TypeScript で Cursor の AI エージェントをプログラムから実行するための公式 SDK です。ローカル環境またはクラウド環境でエージェントを起動し、コードベースの操作、Pull Request の作成などを実行できます。

インストール方法

npm install @cursor/sdk

Cursor Integrations ダッシュボード(https://cursor.com/dashboard/integrations)から API Key を取得し、CURSOR_API_KEY 環境変数に設定します。

サンプルコード

import { Agent } from "@cursor/sdk";

async function main() {
  // エージェントの作成(ローカル実行例)
  const agent = await Agent.create({
    apiKey: process.env.CURSOR_API_KEY!,
    model: { id: "composer-2.5" },           // または "gpt-5.5" など
    local: { cwd: process.cwd() },         // 現在のディレクトリを対象
  });

  try {
    const run = await agent.send(
      "このリポジトリの概要を日本語で簡潔にまとめてください。"
    );

    // ストリーミングで応答を取得
    for await (const event of run.stream()) {
      if (event.type === "assistant") {
        process.stdout.write(event.text || "");
      }
    }

    console.log("\n\nRun completed.");
  } finally {
    await agent.dispose(); // リソース解放
  }
}

main().catch(console.error);

以下のコマンドでコードを実行します。

node --env-file=.env --import tsx/esm src/quickstart.ts

公式リソース

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!
目次