Skip to main content
Server path: /cursor | Type: Application | PCID required: Yes

Tools

ToolDescription
cursor_archive_agentArchive an agent
cursor_cancel_runCancel a run
cursor_create_agentCreate an agent
cursor_create_runCreate a run
cursor_create_sub_tokenCreate A User-Scoped Worker Token
cursor_delete_agentDelete an agent permanently
cursor_download_artifactDownload an artifact
cursor_get_agentGet an agent
cursor_get_api_key_infoAPI key info
cursor_get_runGet a run
cursor_list_agentsList agents
cursor_list_artifactsList artifacts
cursor_list_modelsList models
cursor_list_repositoriesList GitHub repositories
cursor_list_runsList runs
cursor_stream_runStream a run
cursor_unarchive_agentUnarchive an agent

cursor_archive_agent

Archive an agent Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.

cursor_cancel_run

Cancel a run Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.
runIdstringYesUnique identifier for the run.

cursor_create_agent

Create an agent Parameters:
ParameterTypeRequiredDefaultDescription
autoCreatePRbooleanNoWhether Cursor should open a pull request when the run completes.
autoGenerateBranchbooleanNoWhether to create a new branch (true) or push to an existing head branch (false). Only applies when repos[0].prUrl is provided.
branchNamestringNoCustom branch name for the agent to create.
envVarsobjectNoSession-scoped environment variables for the cloud agent. Values are encrypted at rest, injected into the agent’s shell, and deleted with the agent. Names must be non-empty, 1024 bytes or less, and cannot start with CURSOR_. Values must be non-empty and 4096 bytes or less.
modelobjectNoThe model value
promptobjectYesThe prompt value
reposobject[]YesRepository configuration. v1 currently supports one entry.
skipReviewerRequestbooleanNoWhether to skip requesting the user as a reviewer when Cursor opens a PR. Only applies when autoCreatePR is true.

cursor_create_run

Create a run Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.
promptobjectYesThe prompt value

cursor_create_sub_token

Create A User-Scoped Worker Token Parameters:
ParameterTypeRequiredDefaultDescription
forUserEmailstringNoActive team member email. Case-insensitive. Mutually exclusive with forUserId.
forUserIdintegerNoActive team member’s numeric Cursor user ID. Mutually exclusive with forUserEmail.

cursor_delete_agent

Delete an agent permanently Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.

cursor_download_artifact

Download an artifact Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.
pathstringYesRelative artifact path under artifacts/.

cursor_get_agent

Get an agent Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.

cursor_get_api_key_info

API key info

cursor_get_run

Get a run Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.
runIdstringYesUnique identifier for the run.

cursor_list_agents

List agents Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoNumber of agents to return.
cursorstringNoPagination cursor from the previous response.
prUrlstringNoFilter agents by GitHub pull request URL.
includeArchivedbooleanNoWhether to include archived agents.

cursor_list_artifacts

List artifacts Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.

cursor_list_models

List models

cursor_list_repositories

List GitHub repositories

cursor_list_runs

List runs Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.
limitintegerNoMaximum number of results to return
cursorstringNoPagination cursor from the previous response.

cursor_stream_run

Stream a run Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.
runIdstringYesUnique identifier for the run.
Last-Event-IDstringNoResume from a previously received event ID for this run.

cursor_unarchive_agent

Unarchive an agent Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesUnique identifier for the agent.