View as Markdown
Cursor icon

Cursor ACTION

Launch Agent

Launch a Cursor agent. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Cursor account once, then configure and run Launch Agent from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "cursor-launch-agent",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    cursor: { authProvisionId: "apn_xxxxxxx" },
    prompt: "Prompt",
    sourceRepository: "Source Repository",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Launch Agent inputs
Property Type Description
prompt Prompt string
The instruction text for the agent
Required
sourceRepository Source Repository string
GitHub repository URL (e.g., https://github.com/your-org/your-repo)
Required Dynamic
sourceRef Source Ref string
Git ref (branch name, tag, or commit hash) to use as the base branch
Optional
model Model string
The model to use for the request. If not provided, we'll pick the most appropriate model.
Optional Dynamic
autoCreatePr Auto Create PR boolean
Whether to automatically create a pull request when the agent completes
Optional
openAsCursorGithubApp Open as Cursor Github App boolean
Whether to open the pull request as the Cursor GitHub App instead of as the user. Only applies if autoCreatePr is true.
Optional
skipReviewerRequest Skip Reviewer Request boolean
Whether to skip adding the user as a reviewer to the pull request. Only applies if autoCreatePr is true and the PR is opened as the Cursor GitHub App.
Optional
targetBranch Target Branch string
Custom branch name for the agent to create
Optional
webhookUrl Webhook URL string
URL to receive webhook notifications about agent status changes
Optional
images Images string[]
Images to use for the request (max 5). This can be a file URL or path to a file in the /tmp directory (for example, /tmp/example.jpg)
Optional
syncDir SyncDir dir
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
cursor-launch-agent
Version
0.0.2
App
Cursor
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes