Skip to content

Commit da88dea

Browse files
byrrobyrro
authored
Cursor Agents Starter MCP Server documentation (#511)
* Cursor Agents starter tools docs * upgrade design-system
1 parent 34eafcc commit da88dea

17 files changed

+3487
-5241
lines changed

‎app/en/mcp-servers/development/cursor-agents-api/page.mdx‎

Lines changed: 273 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,273 @@
1+
# CursorAgentsApi
2+
3+
import StarterToolInfo from "@/app/_components/starter-tool-info";
4+
import ToolInfo from "@/app/_components/tool-info";
5+
import Badges from "@/app/_components/badges";
6+
import TabbedCodeBlock from "@/app/_components/tabbed-code-block";
7+
import TableOfContents from "@/app/_components/table-of-contents";
8+
import ToolFooter from "@/app/_components/tool-footer";
9+
import { Callout } from "nextra/components";
10+
11+
<ToolInfo
12+
description="Tools that enable LLMs to interact directly with the cursor_agents API."
13+
author="Arcade"
14+
authType="API Key"
15+
versions={["0.1.0"]}
16+
/>
17+
18+
<Badges repo="arcadeai/arcade_cursor_agents_api" />
19+
20+
<StarterToolInfo toolkitName="CursorAgentsApi" />
21+
22+
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:
23+
24+
- List, inspect, and delete background agents.
25+
- Retrieve an agent’s current status, results, and full conversation history.
26+
- Verify API key / user info used for authentication.
27+
- Fetch recommended models for background agents.
28+
- List GitHub repositories accessible to the authenticated user.
29+
30+
## Available Tools
31+
32+
<TableOfContents
33+
headers={["Tool Name", "Description"]}
34+
data={[
35+
[
36+
"CursorAgentsApi.ListBackgroundAgents",
37+
"List all background agents for the user.",
38+
],
39+
[
40+
"CursorAgentsApi.GetAgentStatus",
41+
"Retrieve the current status and results of a background agent.",
42+
],
43+
[
44+
"CursorAgentsApi.DeleteBackgroundAgent",
45+
"Permanently delete a background agent.",
46+
],
47+
[
48+
"CursorAgentsApi.GetAgentConversationHistory",
49+
"Retrieve the conversation history of a background agent.",
50+
],
51+
[
52+
"CursorAgentsApi.RetrieveApiUserInfo",
53+
"Retrieve information about the API key used for authentication.",
54+
],
55+
[
56+
"CursorAgentsApi.ListRecommendedModels",
57+
"Retrieve recommended models for background agents.",
58+
],
59+
[
60+
"CursorAgentsApi.ListGithubRepositories",
61+
"Retrieve accessible GitHub repositories for a user.",
62+
],
63+
]}
64+
/>
65+
66+
<Callout>
67+
If you need to perform an action that's not listed here, you can [get in touch
68+
with us](mailto:[email protected]) to request a new tool, or [create your own
69+
tools](/home/build-tools/create-a-mcp-server).
70+
</Callout>
71+
72+
## CursorAgentsApi.ListBackgroundAgents
73+
74+
<br />
75+
<TabbedCodeBlock
76+
tabs={[
77+
{
78+
label: "Call the Tool Directly",
79+
content: {
80+
Python: [
81+
"/examples/integrations/mcp-servers/cursor_agents_api/list_background_agents_example_call_tool.py",
82+
],
83+
JavaScript: [
84+
"/examples/integrations/mcp-servers/cursor_agents_api/list_background_agents_example_call_tool.js",
85+
],
86+
},
87+
},
88+
]}
89+
/>
90+
91+
List all background agents for the user.
92+
93+
**Parameters**
94+
95+
- **agent_limit** (`integer`, optional) Number of background agents to return for the request.
96+
- **pagination_cursor** (`string`, optional) Pagination cursor from the previous response to navigate pages.
97+
98+
**Secrets**
99+
100+
This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets))
101+
102+
## CursorAgentsApi.GetAgentStatus
103+
104+
<br />
105+
<TabbedCodeBlock
106+
tabs={[
107+
{
108+
label: "Call the Tool Directly",
109+
content: {
110+
Python: [
111+
"/examples/integrations/mcp-servers/cursor_agents_api/get_agent_status_example_call_tool.py",
112+
],
113+
JavaScript: [
114+
"/examples/integrations/mcp-servers/cursor_agents_api/get_agent_status_example_call_tool.js",
115+
],
116+
},
117+
},
118+
]}
119+
/>
120+
121+
Retrieve the current status and results of a background agent.
122+
123+
**Parameters**
124+
125+
- **background_agent_id** (`string`, required) A unique identifier required to retrieve the status and results of the specified background agent.
126+
127+
**Secrets**
128+
129+
This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets))
130+
131+
## CursorAgentsApi.DeleteBackgroundAgent
132+
133+
<br />
134+
<TabbedCodeBlock
135+
tabs={[
136+
{
137+
label: "Call the Tool Directly",
138+
content: {
139+
Python: [
140+
"/examples/integrations/mcp-servers/cursor_agents_api/delete_background_agent_example_call_tool.py",
141+
],
142+
JavaScript: [
143+
"/examples/integrations/mcp-servers/cursor_agents_api/delete_background_agent_example_call_tool.js",
144+
],
145+
},
146+
},
147+
]}
148+
/>
149+
150+
Permanently delete a background agent.
151+
152+
**Parameters**
153+
154+
- **background_agent_id** (`string`, required) Unique identifier for the background agent to be deleted permanently.
155+
156+
**Secrets**
157+
158+
This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets))
159+
160+
## CursorAgentsApi.GetAgentConversationHistory
161+
162+
<br />
163+
<TabbedCodeBlock
164+
tabs={[
165+
{
166+
label: "Call the Tool Directly",
167+
content: {
168+
Python: [
169+
"/examples/integrations/mcp-servers/cursor_agents_api/get_agent_conversation_history_example_call_tool.py",
170+
],
171+
JavaScript: [
172+
"/examples/integrations/mcp-servers/cursor_agents_api/get_agent_conversation_history_example_call_tool.js",
173+
],
174+
},
175+
},
176+
]}
177+
/>
178+
179+
Retrieve the conversation history of a background agent.
180+
181+
**Parameters**
182+
183+
- **background_agent_id** (`string`, required) Unique identifier for the background agent to retrieve conversation history.
184+
185+
**Secrets**
186+
187+
This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets))
188+
189+
## CursorAgentsApi.RetrieveApiUserInfo
190+
191+
<br />
192+
<TabbedCodeBlock
193+
tabs={[
194+
{
195+
label: "Call the Tool Directly",
196+
content: {
197+
Python: [
198+
"/examples/integrations/mcp-servers/cursor_agents_api/retrieve_api_user_info_example_call_tool.py",
199+
],
200+
JavaScript: [
201+
"/examples/integrations/mcp-servers/cursor_agents_api/retrieve_api_user_info_example_call_tool.js",
202+
],
203+
},
204+
},
205+
]}
206+
/>
207+
208+
Retrieve information about the API key used for authentication.
209+
210+
**Parameters**
211+
212+
This tool does not take any parameters.
213+
**Secrets**
214+
215+
This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets))
216+
217+
## CursorAgentsApi.ListRecommendedModels
218+
219+
<br />
220+
<TabbedCodeBlock
221+
tabs={[
222+
{
223+
label: "Call the Tool Directly",
224+
content: {
225+
Python: [
226+
"/examples/integrations/mcp-servers/cursor_agents_api/list_recommended_models_example_call_tool.py",
227+
],
228+
JavaScript: [
229+
"/examples/integrations/mcp-servers/cursor_agents_api/list_recommended_models_example_call_tool.js",
230+
],
231+
},
232+
},
233+
]}
234+
/>
235+
236+
Retrieve recommended models for background agents.
237+
238+
**Parameters**
239+
240+
This tool does not take any parameters.
241+
**Secrets**
242+
243+
This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets))
244+
245+
## CursorAgentsApi.ListGithubRepositories
246+
247+
<br />
248+
<TabbedCodeBlock
249+
tabs={[
250+
{
251+
label: "Call the Tool Directly",
252+
content: {
253+
Python: [
254+
"/examples/integrations/mcp-servers/cursor_agents_api/list_github_repositories_example_call_tool.py",
255+
],
256+
JavaScript: [
257+
"/examples/integrations/mcp-servers/cursor_agents_api/list_github_repositories_example_call_tool.js",
258+
],
259+
},
260+
},
261+
]}
262+
/>
263+
264+
Retrieve accessible GitHub repositories for a user.
265+
266+
**Parameters**
267+
268+
This tool does not take any parameters.
269+
**Secrets**
270+
271+
This tool requires the following secrets: `CURSOR_AGENTS_API_KEY` (learn how to [configure secrets](/home/build-tools/create-a-tool-with-secrets))
272+
273+
<ToolFooter pipPackageName="arcade_cursor_agents_api" />

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
},
3232
"homepage": "https://arcade.dev/",
3333
"dependencies": {
34-
"@arcadeai/design-system": "^3.5.4",
34+
"@arcadeai/design-system": "^3.8.0",
3535
"@next/third-parties": "15.5.4",
3636
"@ory/client": "1.22.5",
3737
"@theguild/remark-mermaid": "0.3.0",

0 commit comments

Comments
 (0)