Cursor
Launch and manage Cursor cloud agents to work on GitHub repositories
Configuration
Launch Agent
Operation
Launch Agent
API Key*
••••••••
Repository URL*
https://github.com/your-org/your-repo
Branch/Ref
main (optional)
Prompt*
Describe the task for the agent...
Model
Auto-selection by default
Branch Name
Custom branch name (optional)
Auto Create PR
Disabled
Open as Cursor GitHub App
Disabled
Skip Reviewer Request
Disabled
Launch Agent (
cursor_launch_agent)Start a new cloud agent to work on a GitHub repository with the given instructions.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Cursor API key |
repository | string | Yes | GitHub repository URL (e.g., https://github.com/your-org/your-repo\) |
ref | string | No | Branch, tag, or commit to work from (defaults to default branch) |
promptText | string | Yes | The instruction text for the agent |
promptImages | string | No | JSON array of image objects with base64 data and dimensions |
model | string | No | Model to use (leave empty for auto-selection) |
branchName | string | No | Custom branch name for the agent to use |
autoCreatePr | boolean | No | Automatically create a PR when the agent finishes |
openAsCursorGithubApp | boolean | No | Open the PR as the Cursor GitHub App |
skipReviewerRequest | boolean | No | Skip requesting reviewers on the PR |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Success message with agent details |
id | string | Agent ID |
Add Follow-up
Operation
Add Follow-up
API Key*
••••••••
Agent ID*
e.g., bc_abc123
Follow-up Prompt*
Additional instructions for the agent...
Add Follow-up (
cursor_add_followup)Add a follow-up instruction to an existing cloud agent.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
followupPromptText | string | Yes | The follow-up instruction text for the agent |
promptImages | string | No | JSON array of image objects with base64 data and dimensions (max 5) |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Success message |
Get Agent Status
Operation
Get Agent Status
API Key*
••••••••
Agent ID*
e.g., bc_abc123
Get Agent Status (
cursor_get_agent)Retrieve the current status and results of a cloud agent.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Human-readable agent details |
id | string | Agent ID |
name | string | Agent name |
status | string | Agent status |
source | object | Source repository info |
target | object | Target branch info |
summary | string | Agent summary |
Get Conversation
Operation
Get Conversation
API Key*
••••••••
Agent ID*
e.g., bc_abc123
Get Conversation (
cursor_get_conversation)Retrieve the conversation history of a cloud agent, including all user prompts and assistant responses.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Human-readable conversation history |
id | string | Agent ID |
List Agents
Operation
List Agents
API Key*
••••••••
Limit
20 (default, max 100)
Pagination Cursor
Cursor from previous response
List Agents (
cursor_list_agents)List all cloud agents for the authenticated user with optional pagination.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Cursor API key |
limit | number | No | Number of agents to return (default: 20, max: 100) |
cursor | string | No | Pagination cursor from previous response |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Human-readable list of agents |
agents | array | Array of agent objects |
Stop Agent
Operation
Stop Agent
API Key*
••••••••
Agent ID*
e.g., bc_abc123
Stop Agent (
cursor_stop_agent)Stop a running cloud agent. This pauses the agent without deleting it.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Success message |
Delete Agent
Operation
Delete Agent
API Key*
••••••••
Agent ID*
e.g., bc_abc123
Delete Agent (
cursor_delete_agent)Permanently delete a cloud agent. This action cannot be undone.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Cursor API key |
agentId | string | Yes | Unique identifier for the cloud agent (e.g., bc_abc123) |
Output
| Parameter | Type | Description |
|---|---|---|
content | string | Success message |
Usage Instructions
Interact with Cursor Cloud Agents API to launch AI agents that can work on your GitHub repositories. Supports launching agents, adding follow-up instructions, checking status, viewing conversations, and managing agent lifecycle.
Notes
- Category:
tools - Type:
cursor