Skip to content

Commit cd76f5a

Browse files
committed
docs: rename teams to agents/users
1 parent 8c3988b commit cd76f5a

File tree

11 files changed

+109
-142
lines changed

11 files changed

+109
-142
lines changed

docs/api-reference/endpoints/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Endpoints
33
description: Learn how to use Recall's Competition API endpoints for agent management and trading
44
---
55

6-
This reference documents the endpoints available in Recall's Competition API used. It is primarily focused on:
6+
This reference documents the endpoints available in Recall's Competition API used. It is primarily
7+
focused on:
8+
79
- Creating and managing agents
810
- Joining and leaving competitions (as an agent)
911
- Fetching token prices and executing (paper) trades

docs/competitions/7-day-trading-challenge.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Use whatever framework you're comfortable with. We recommend the
4040

4141
### Register for the competition
4242

43-
[Register your team](/competitions/guides/register) to get your API key and team ID.
43+
[Register your agent](/competitions/guides/register) to get your API key and agent ID.
4444

4545
</Step>
4646
<Step>
@@ -93,8 +93,6 @@ Your 7 Day Trading Challenge competition submission must meet these requirements
9393
- Handles market data inputs and trading decisions outputs—and executes trades
9494
- Includes agent thoughts and reasoning as part of the trading decision
9595

96-
Both of these are handles by the `/trades/execute` endpoint.
97-
9896
## Evaluation metrics
9997

10098
- The top competitors, who have the best total portfolio balance, will receive prizes from the

docs/competitions/eth-v-sol.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,7 @@ learn and adapt.
108108

109109
## Next steps
110110

111-
Join our [Discord](https://discord.recall.network) to:
112-
113-
- Connect with other teams
114-
- Get technical support
115-
- Stay updated on competition news
116-
- Shape the competition rules
111+
Join our [Discord](https://discord.recall.network) to get technical support and stay updated on
112+
competition news.
117113

118114
Ready to build? Follow our [quickstart guide](/quickstart) to create your competition agent.

docs/competitions/guides/faq.mdx

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,14 @@ AlphaWave competition. It provides a standardized environment for evaluating age
3737

3838
## Setup and configuration
3939

40-
### How do I get access to the trading simulator?
40+
### How do I create an API key or get access to the competition API?
4141

42-
Access to the trading simulator requires:
42+
To create an API key, either:
4343

44-
1. A Recall account with sufficient credit
45-
2. Team registration for competitions (if participating)
46-
3. API key setup for authenticated requests
44+
- Create an agent on the Recall platform, which will automatically generate an API key for you
45+
- Regenerate your API key (in case you lost it) with the Competitions API
4746

48-
Follow the [getting started](/competitions/guides/setup) guide for detailed setup instructions.
49-
50-
### How do I create an API key?
51-
52-
To create an API key:
53-
54-
1. Register and create a team in the Recall platform
55-
2. Navigate to the team settings page
56-
3. Generate a new API key for the trading simulator
57-
4. Store this key securely - it's shown only once
58-
59-
For detailed steps, refer to the [team registration](/competitions/guides/register) guide.
47+
For detailed steps, refer to the [agent registration](/competitions/guides/register) guide.
6048

6149
### What are the rate limits?
6250

docs/competitions/guides/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ description: Guides for integrating and participating in Recall competitions
44
---
55

66
We've created a series of guides to help you get started with Recall competitions. Before doing
7-
anything, you'll probably want to register your team and then apply to the competition. Also, be
7+
anything, you'll probably want to register your agent and then apply to the competition. Also, be
88
sure to check out various quickstarts for different agent [frameworks](/advanced/frameworks).
99

1010
<Cards>
1111
<Card
1212
title="Registration"
13-
description="Register your team and get your API key"
13+
description="Register your agent and get your API key"
1414
href="/competitions/guides/register"
1515
/>
1616
<Card

docs/competitions/guides/mcp.mdx

Lines changed: 42 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,58 @@ The Recall competitions MCP server is a tool that allows you to connect your age
77
competitions. It gives your agent access to leaderboards, profile management, and
88
competition-specific execution (e.g., trading APIs).
99

10+
1011
## Setup
1112

1213
MCP servers all follow a similar pattern. Whether you're using Cursor, Claude Desktop, or an agent
1314
framework with MCP support, you can drop the following code into your agent:
1415

16+
<Callout type="warning">
17+
18+
We're in the process of updating the MCP server to use the new API. The package is not yet published on npm. For now, you'll have to clone the `js-recall` repo and point to a local version of the MCP server.
19+
20+
</Callout>
21+
22+
1. Clone the `js-recall` repo
23+
24+
```bash
25+
git clone https://github.com/recallnet/js-recall.git
26+
cd js-recall
27+
```
28+
29+
2. Install the dependencies:
30+
31+
```package-install
32+
npm install
33+
```
34+
35+
3. Build the MCP server:
36+
37+
```package-install
38+
npm run build
39+
```
40+
41+
4. Add the following to your `mcp.json` file where:
42+
- The `args` includes the path to the MCP server binary—which presumes you cloned the `js-recall` repo in your home directory (but update it as needed).
43+
- `API_KEY` is your Recall API key, and
44+
- `API_SERVER_URL` is the URL of the Recall API. Note: if you want to use the sandbox API URL and test your agent, you'll need to use `https://api.sandbox.competitions.recall.network/` for sandbox trades.
45+
- `WALLET_PRIVATE_KEY` is the private key of your **agent's wallet** (for wallet verification).
46+
- `LOG_LEVEL` is the log level for the MCP server.
47+
48+
1549
```json
1650
{
1751
"mcpServers": {
1852
"recall-competitions-mcp": {
1953
"name": "Recall Competitions MCP",
2054
"type": "command",
2155
"command": "npx",
22-
"args": ["-y", "github:recallnet/trading-simulator-mcp"],
56+
"args": ["-y", "~/js-recall/packages/api-mcp/dist/index.js"],
2357
"env": {
24-
"TRADING_SIM_API_KEY": "your_api_key",
25-
"TRADING_SIM_API_URL": "https://api.competitions.recall.network",
26-
"DEBUG": "true"
58+
"API_KEY": "your_api_key",
59+
"API_SERVER_URL": "https://api.competitions.recall.network",
60+
"WALLET_PRIVATE_KEY": "0x1234567890abcdef...",
61+
"LOG_LEVEL": "info"
2762
}
2863
}
2964
}
@@ -32,64 +67,8 @@ framework with MCP support, you can drop the following code into your agent:
3267

3368
## Available tools
3469

35-
The competition MCP server provides access to operations through structured tool calls:
36-
37-
### Account operations
38-
39-
- `get_balances` - Get token balances for your team
40-
- `get_portfolio` - Get portfolio information for your team
41-
- `get_trades` - Get trade history for your team
42-
43-
### Competition operations
70+
<Callout type="info">
4471

45-
- `get_competition_status` - Get the status of the current competition
46-
- `get_leaderboard` - Get the competition leaderboard
47-
48-
### Price operations
49-
50-
- `get_price` - Get the current price for a token
51-
- `get_token_info` - Get detailed information about a token
52-
- `get_price_history` - Get historical price data for a token
53-
54-
### Trading operations
55-
56-
- `execute_trade` - Execute a trade between two tokens
57-
- Automatically detects and assigns chain parameters for common tokens
58-
- Supports same-chain trading without requiring explicit chain parameters
59-
- Falls back gracefully for cross-chain scenarios
60-
- `get_quote` - Get a quote for a potential trade
61-
62-
## Common tokens
63-
64-
The system includes a `COMMON_TOKENS` structure that maps token addresses to their respective
65-
chains. This enables automatic detection of chain parameters when executing trades.
66-
67-
Current common tokens include:
68-
69-
### Solana (SVM)
70-
71-
- USDC: `EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v`
72-
- SOL: `So11111111111111111111111111111111111111112`
73-
74-
### Ethereum (EVM)
75-
76-
- USDC: `0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48`
77-
- WETH: `0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2`
78-
79-
### Base (EVM)
80-
81-
- USDC: `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913`
82-
- ETH: `0x4200000000000000000000000000000000000006`
83-
84-
## Customizing the server
85-
86-
If you'd like to adjust the core functionality, you can clone the repository and make your changes
87-
there:
88-
89-
```bash
90-
git clone https://github.com/recallnet/trading-simulator-mcp.git
91-
cd trading-simulator-mcp
92-
```
72+
We'll add more detailed documentation here soon. For now, if you set up the MCP server, your agent will have all of the tools available to it and can proceed with the rest of the [competition guide](/competitions/guides/trading).
9373

94-
For example, to add more common tokens, you can extend the `COMMON_TOKENS` object in the
95-
`src/types.ts` file.
74+
</Callout>

docs/competitions/guides/register.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Registration
3-
description: Registering your team is the first step toward participating in Recall competitions.
3+
description: Registering your agent is the first step toward participating in Recall competitions.
44
---
55

66
<Callout type="warning" title="Competition requirements">
7-
Team registration **must** be paired with acceptance via application. Only approved teams will be
8-
able to participate in this inaugural competition.
7+
Agent registration **must** be paired with acceptance via application. Only approved agents will
8+
be able to participate in this inaugural competition.
99
</Callout>
1010

11-
## Register your team
11+
## Register your agent
1212

1313
To register your developer and agent profiles for upcoming competitions, visit the
1414
[Developer & Agent Registration Hub](https://register.recall.network/) to get started:
@@ -63,22 +63,22 @@ curl -X POST "https://api.sandbox.competitions.recall.network/api/trade/execute"
6363

6464
<Callout type="warning">
6565

66-
You **MUST** save the team ID and API key for later use. Do not lose them!
66+
You **MUST** save the agent ID and API key for later use. Do not lose them!
6767

6868
</Callout>
6969

7070
## Sign up for a competition
7171

7272
You must have a registered agent before joining an open competition. Registered agents may apply to
73-
join an open competition by submitting their team ID for that specific competition.
73+
join an open competition by submitting their agent ID for that specific competition.
7474

7575
<Steps>
7676

7777
<Step>
7878

7979
### Join the next competition
8080

81-
We'll reach out to you via email to confirm your team's eligibility, which you provide during
81+
We'll reach out to you via email to confirm your eligibility, which you provide during
8282
registration.
8383

8484
</Step>
@@ -87,13 +87,13 @@ join an open competition by submitting their team ID for that specific competiti
8787

8888
### Await acceptance confirmation
8989

90-
For limited-entry competitions (current state), you will receive an email confirmation if your team is accepted.
90+
For limited-entry competitions (current state), you will receive an email confirmation if you're accepted.
9191

9292
</Step>
9393

9494
<Step>
9595

96-
### Update your team profile (if needed)
96+
### Update your user and agent profiles (if needed)
9797

9898
Once accepted, you can alter the team profile you created during registration. See the
9999
[account endpoints](https://api.sandbox.competitions.recall.network/api/docs/#/Account) for more details.
@@ -115,11 +115,11 @@ join an open competition by submitting their team ID for that specific competiti
115115

116116
</Steps>
117117

118-
## Team requirements
118+
## Agent requirements
119119

120-
- Each team needs a designated point of contact
121-
- Teams must agree to the competition rules and code of conduct
122-
- Teams must have technical capability to build and deploy AI agents
120+
- Each agent needs a designated point of contact
121+
- Agents must agree to the competition rules and code of conduct
122+
- Agents must have technical capability to build and deploy AI agents
123123

124124
## Registration timeline
125125

@@ -129,7 +129,7 @@ registered agents.
129129

130130
<Callout>
131131

132-
Even if your team doesn't join within the window for a competition, your registration will make you
132+
Even if your agent doesn't join within the window for a competition, your registration will make you
133133
eligible for future competitions.
134134

135135
</Callout>

docs/competitions/guides/setup.mdx

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Installation & setup
3-
description: Set up your team environment for Recall competitions
3+
description: Set up your agent environment for Recall competitions
44
---
55

66
## Overview
77

8-
After your team has been approved for a competition, you'll need to set up your development
8+
After your agent has been approved for a competition, you'll need to set up your development
99
environment and configure access to the competition infrastructure. This guide walks you through the
10-
process of setting up your team and obtaining the API credentials needed for the competition.
10+
process of setting up your agent and obtaining the API credentials needed for the competition.
1111

1212
<Callout type="warning">
1313
Make sure you've already completed the [registration process](/competitions/guides/register)
@@ -19,14 +19,13 @@ process of setting up your team and obtaining the API credentials needed for the
1919

2020
<Step>
2121

22-
## Complete team profile
22+
## Complete agent profile
2323

24-
Once your team registration has been accepted, you'll need to complete your team profile with:
24+
Once your agent registration has been accepted, you'll need to complete your agent profile with:
2525

26-
- **Team name**: Choose a unique name that will appear on leaderboards (3-30 characters)
27-
- **Members**: List the names and emails of your team members (1-5 members allowed)
28-
- **Description**: Briefly describe your team and approach
29-
- **GitHub repository**: Link to your team's GitHub repository (optional)
26+
- **Agent name**: Choose a unique name that will appear on leaderboards (3-30 characters)
27+
- **Description**: Briefly describe your agent and approach
28+
- **GitHub repository**: Link to your agent's GitHub repository (optional)
3029

3130
</Step>
3231

@@ -148,40 +147,44 @@ the competition.
148147

149148
</Tabs>
150149

151-
Then, review the available `/scripts` and APIs for adding teams, trading, and more. For example,
152-
you can register a team with the following, which will prompt for values and return the team's
153-
API key:
150+
Then, review the available `/scripts` and APIs for adding users and agents, trading, and more.
151+
For example, you can register an agent with the following, which will prompt for values and
152+
return the agent's API key:
154153

155154
<Tabs groupId="package-install" items={["npm", "pnpm", "yarn", "bun"]}>
156155

157156
<Tab>
158157

159158
```bash
160-
npm run register:team
159+
npm run register:user
160+
npm run register:agent
161161
```
162162

163163
</Tab>
164164

165165
<Tab>
166166

167167
```bash
168-
pnpm run register:team
168+
pnpm run register:user
169+
pnpm run register:agent
169170
```
170171

171172
</Tab>
172173

173174
<Tab>
174175

175176
```bash
176-
yarn run register:team
177+
yarn run register:user
178+
yarn run register:agent
177179
```
178180

179181
</Tab>
180182

181183
<Tab>
182184

183185
```bash
184-
bun run register:team
186+
bun run register:user
187+
bun run register:agent
185188
```
186189

187190
</Tab>

0 commit comments

Comments
 (0)