Cursor Agents API
Tools that enable LLMs to interact directly with the Cursor Background Agents API.
0.1.1
The CursorAgentsApi toolkit enables developers to interact with the Cursor Background Agents API, providing a structured way to manage and utilize background agents effectively.
Capabilities:
- Manage background agents with operations to create, delete, and retrieve their statuses.
- Access conversation history for insights into agent interactions.
- List all agents and their recommended models for tailored implementations.
- Integrate with GitHub to access user repositories seamlessly.
OAuth:
- Authentication is done via an API key, specifically using the
CURSOR_AGENTS_API_KEY.
Secrets:
- The toolkit uses secrets in the form of an API key, which grants access to features and capabilities of the CursorAgentsApi.
Available tools(7)
| Tool name | Description | Secrets | |
|---|---|---|---|
Permanently delete a background agent.
This tool is used to permanently delete a background agent. This action cannot be undone, so it should be called with caution when you need to remove an agent completely. | 1 | ||
Retrieve the conversation history of a background agent.
This tool retrieves the full conversation history, including user prompts and assistant responses, for a specified background agent. It is useful for reviewing past interactions and understanding agent behavior. | 1 | ||
Retrieve the current status and results of a background agent.
Call this tool to get information about the status and results of a specific background agent by providing its ID. | 1 | ||
List all background agents for the user.
Use this tool to retrieve a list of all background agents associated with the authenticated user. | 1 | ||
Retrieve accessible GitHub repositories for a user.
Use this tool to get a list of GitHub repositories that the authenticated user can access. It pulls data from the user's GitHub account and returns the repositories they have permission to view or modify. | 1 | ||
Retrieve recommended models for background agents.
Use this tool to fetch a list of models recommended for use in background agent applications. | 1 | ||
Retrieve information about the API key used for authentication.
This tool calls the endpoint to get details regarding the API key currently in use, including any relevant user information. It should be called when there is a need to verify or display details about the authentication being used. | 1 |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
CursorAgentsApi.DeleteBackgroundAgent
Permanently delete a background agent. This tool is used to permanently delete a background agent. This action cannot be undone, so it should be called with caution when you need to remove an agent completely.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
background_agent_id | string | Required | Unique identifier for the background agent to be deleted permanently. |
Requirements
Output
json— Response from the API endpoint 'deleteAgent'.CursorAgentsApi.GetAgentConversationHistory
Retrieve the conversation history of a background agent. This tool retrieves the full conversation history, including user prompts and assistant responses, for a specified background agent. It is useful for reviewing past interactions and understanding agent behavior.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
background_agent_id | string | Required | Unique identifier for the background agent to retrieve conversation history. |
Requirements
Output
json— Response from the API endpoint 'getAgentConversation'.CursorAgentsApi.GetAgentStatus
Retrieve the current status and results of a background agent. Call this tool to get information about the status and results of a specific background agent by providing its ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
background_agent_id | string | Required | A unique identifier required to retrieve the status and results of the specified background agent. |
Requirements
Output
json— Response from the API endpoint 'getAgent'.CursorAgentsApi.ListBackgroundAgents
List all background agents for the user. Use this tool to retrieve a list of all background agents associated with the authenticated user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
agent_limit | integer | Optional | Number of background agents to return for the request. |
pagination_cursor | string | Optional | Pagination cursor from the previous response to navigate pages. |
Requirements
Output
json— Response from the API endpoint 'listAgents'.CursorAgentsApi.ListGithubRepositories
Retrieve accessible GitHub repositories for a user. Use this tool to get a list of GitHub repositories that the authenticated user can access. It pulls data from the user's GitHub account and returns the repositories they have permission to view or modify.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listRepositories'.CursorAgentsApi.ListRecommendedModels
Retrieve recommended models for background agents. Use this tool to fetch a list of models recommended for use in background agent applications.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'listModels'.CursorAgentsApi.RetrieveApiUserInfo
Retrieve information about the API key used for authentication. This tool calls the endpoint to get details regarding the API key currently in use, including any relevant user information. It should be called when there is a need to verify or display details about the authentication being used.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getMe'.