エージェントを起動

このピースでできること

  • Cursorでクラウドエージェントを起動し、GitHubリポジトリに対する作業(コード修正やドキュメント作成など)を依頼します。
  • 必要に応じて、エージェント完了時にPull Requestを自動作成します。
  • 必要に応じて、エージェントのステータス変更をWebhookで通知します。
 

Cursor の接続方法

workrun と Cursor を接続するには、Cursor の API キー が必要です。
⚠️ Cursor の Cloud Agent API は現在ベータ版です。

ステップ 1:API キーを取得する

  1. Cursor ダッシュボード にアクセスします。
  1. 「User API Keys」 セクションまでスクロールします。
  1. 「+ New API Key」 をクリックします。
  1. 生成されたキー( の形式)をコピーします。
⚠️ API キーは他人に共有しないようにしてください。

ステップ 2:workrun に接続を追加する

  1. workrun で Cursor のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「API Key」 フィールドに、ステップ 1 でコピーしたキーを貼り付けます。
  1. 「保存」 をクリックして接続を完了します。
 

ピースの設定項目

1. タスクプロンプト(必須)

  • Cursorエージェントに依頼したい作業内容を文章で入力してください。
  • 具体的な成果物や条件を含めると、意図した結果になりやすいです。

2. 画像(任意)

  • 指示の補足として、スクリーンショットなどの画像を添付できます。
  • 最大5枚まで指定できます。
  • 画像ごとに幅(px)と高さ(px)を指定してください。

3. モデル(任意)

  • 使用するLLMモデル名を指定します。
  • 未指定の場合はデフォルトモデルが使用されます。

4. リポジトリURL(必須)

  • 作業対象のGitHubリポジトリURLを入力してください。

5. ベースブランチ/Ref(任意)

  • 作業の起点となるGit ref(ブランチ名、タグ、コミットハッシュ)を入力してください。
  • 未指定の場合は、リポジトリのデフォルトブランチが使われる想定です。

6. PRを自動作成(任意)

  • エージェントの作業完了後に、Pull Requestを自動で作成するかを指定します。

7. Cursor GitHub AppとしてPRを作成(任意)

  • ユーザーではなく、Cursor GitHub AppとしてPRを作成するかを指定します。

8. レビュアー依頼をスキップ(任意)

  • Pull Requestにユーザーをレビュアーとして追加しない場合に有効化します。

9. ブランチ名(任意)

  • エージェントが作業用に作成するブランチ名を指定します。
  • 未指定の場合は、Cursor側で自動生成されます。

10. Webhook URL(任意)

  • エージェントのステータス変更通知を受け取るWebhookのURLを指定します。

11. Webhookシークレット(任意)

  • Webhookペイロードの署名検証に使うシークレットを指定します。
  • 32文字以上の文字列を推奨します。