# CursorAgentsApi

import StarterToolInfo from "@/app/_components/starter-tool-info";
import ToolInfo from "@/app/_components/tool-info";
import Badges from "@/app/_components/badges";
import TabbedCodeBlock from "@/app/_components/tabbed-code-block";
import TableOfContents from "@/app/_components/table-of-contents";
import ToolFooter from "@/app/_components/tool-footer";
import { Callout } from "nextra/components";

<ToolInfo
  description="Tools that enable LLMs to interact directly with the cursor_agents API."
  author="Arcade"
  authType="API Key"
  versions={["0.1.0"]}
/>

<Badges repo="arcadeai/arcade_cursor_agents_api" />

<StarterToolInfo toolkitName="CursorAgentsApi" />

The CursorAgentsApi MCP Server provides tools for managing and inspecting background agents, authentication info, model recommendations, and linked GitHub repos. These tools let users and LLMs:

- List, inspect, and delete background agents.
- Retrieve an agent’s current status, results, and full conversation history.
- Verify API key / user info used for authentication.
- Fetch recommended models for background agents.
- List GitHub repositories accessible to the authenticated user.

## Available Tools

<TableOfContents
  headers={["Tool Name", "Description"]}
  data={[
    [
      "CursorAgentsApi.ListBackgroundAgents",
      "List all background agents for the user.",
    ],
    [
      "CursorAgentsApi.GetAgentStatus",
      "Retrieve the current status and results of a background agent.",
    ],
    [
      "CursorAgentsApi.DeleteBackgroundAgent",
      "Permanently delete a background agent.",
    ],
    [
      "CursorAgentsApi.GetAgentConversationHistory",
      "Retrieve the conversation history of a background agent.",
    ],
    [
      "CursorAgentsApi.RetrieveApiUserInfo",
      "Retrieve information about the API key used for authentication.",
    ],
    [
      "CursorAgentsApi.ListRecommendedModels",
      "Retrieve recommended models for background agents.",
    ],
    [
      "CursorAgentsApi.ListGithubRepositories",
      "Retrieve accessible GitHub repositories for a user.",
    ],
  ]}
/>

<Callout>
  If you need to perform an action that's not listed here, you can [get in touch
  with us](mailto:contact@arcade.dev) to request a new tool, or [create your own
  tools](/guides/create-tools/tool-basics/build-mcp-server).
</Callout>

## CursorAgentsApi.ListBackgroundAgents

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/cursor_agents_api/list_background_agents_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/cursor_agents_api/list_background_agents_example_call_tool.js",
        ],
      },
    },
  ]}
/>

List all background agents for the user.

**Parameters**

- **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.

**Secrets**

This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## CursorAgentsApi.GetAgentStatus

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/cursor_agents_api/get_agent_status_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/cursor_agents_api/get_agent_status_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve the current status and results of a background agent.

**Parameters**

- **background_agent_id** (`string`, required) A unique identifier required to retrieve the status and results of the specified background agent.

**Secrets**

This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## CursorAgentsApi.DeleteBackgroundAgent

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/cursor_agents_api/delete_background_agent_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/cursor_agents_api/delete_background_agent_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Permanently delete a background agent.

**Parameters**

- **background_agent_id** (`string`, required) Unique identifier for the background agent to be deleted permanently.

**Secrets**

This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## CursorAgentsApi.GetAgentConversationHistory

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/cursor_agents_api/get_agent_conversation_history_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/cursor_agents_api/get_agent_conversation_history_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve the conversation history of a background agent.

**Parameters**

- **background_agent_id** (`string`, required) Unique identifier for the background agent to retrieve conversation history.

**Secrets**

This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## CursorAgentsApi.RetrieveApiUserInfo

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/cursor_agents_api/retrieve_api_user_info_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/cursor_agents_api/retrieve_api_user_info_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve information about the API key used for authentication.

**Parameters**

This tool does not take any parameters.
**Secrets**

This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## CursorAgentsApi.ListRecommendedModels

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/cursor_agents_api/list_recommended_models_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/cursor_agents_api/list_recommended_models_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve recommended models for background agents.

**Parameters**

This tool does not take any parameters.
**Secrets**

This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

## CursorAgentsApi.ListGithubRepositories

<br />
<TabbedCodeBlock
  tabs={[
    {
      label: "Call the Tool Directly",
      content: {
        Python: [
          "/examples/integrations/resources/integrations/cursor_agents_api/list_github_repositories_example_call_tool.py",
        ],
        JavaScript: [
          "/examples/integrations/resources/integrations/cursor_agents_api/list_github_repositories_example_call_tool.js",
        ],
      },
    },
  ]}
/>

Retrieve accessible GitHub repositories for a user.

**Parameters**

This tool does not take any parameters.
**Secrets**

This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/guides/create-tools/tool-basics/create-tool-secrets))

<ToolFooter pipPackageName="arcade_cursor_agents_api" />