Skip to content

Commit d0f0374

Browse files
authored
Merge branch 'main' into brace/v2
2 parents bfdc09e + f928f23 commit d0f0374

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

apps/docs/quickstart.mdx

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,34 @@ description: 'Follow these steps to get your Open Agent Platform up and running
55

66
<Info>
77
**Prerequisites:**
8-
- Clone the [Open Agent Platform Repository](https://github.com/langchain-ai/open-agent-platform)
8+
- [Corepack](https://github.com/nodejs/corepack?tab=readme-ov-file#how-to-install) for building and running the platform locally
99
- [LangSmith](https://smith.langchain.com/) Account (free tier is sufficient)
1010
- [Supabase](https://supabase.com/) Account
1111
- MCP Server (e.g. [Arcade](https://arcade-ai.com/))
1212
- An LLM API Key (e.g. [OpenAI](https://platform.openai.com/), [Anthropic](https://console.anthropic.com/), [Google](https://aistudio.google.com/))
1313
</Info>
1414

15-
## 1. Authentication Setup
15+
## 1. Download the Open Agent Platform code
16+
17+
<Steps>
18+
<Step title="Clone the Repository">
19+
Clone the [Open Agent Platform Repository](https://github.com/langchain-ai/open-agent-platform) from GitHub
20+
</Step>
21+
<Step title="Set Environment Variables">
22+
<Tip>
23+
The repository contains a `.env.example` file listing all of the environment variables you need to run the platform.
24+
</Tip>
25+
Set the following environment variables:
26+
```bash
27+
NEXT_PUBLIC_BASE_API_URL="http://localhost:3000/api"
28+
LANGSMITH_API_KEY="lsv2_..."
29+
# Or whichever LLM's API key you're using
30+
OPENAI_API_KEY="..."
31+
```
32+
</Step>
33+
</Steps>
34+
35+
## 2. Authentication Setup
1636

1737
Open Agent Platform uses Supabase for authentication by default.
1838

@@ -22,6 +42,9 @@ Open Agent Platform uses Supabase for authentication by default.
2242
</Step>
2343
<Step title="Configure Environment Variables">
2444
Set the following environment variables inside the `apps/web/` directory:
45+
<Tip>
46+
You can find these Next.js-specific variables in the "Connect" window in the Supabase dashboard, under "App Frameworks"
47+
</Tip>
2548
```bash
2649
NEXT_PUBLIC_SUPABASE_URL="<your supabase url>"
2750
NEXT_PUBLIC_SUPABASE_ANON_KEY="<your supabase anon key>"
@@ -32,7 +55,7 @@ Open Agent Platform uses Supabase for authentication by default.
3255
</Step>
3356
</Steps>
3457

35-
## 2. Deploying Agents
58+
## 3. Deploying Agents
3659

3760
The next step in setting up Open Agent Platform is to deploy and configure your agents.
3861

@@ -77,7 +100,7 @@ The next step in setting up Open Agent Platform is to deploy and configure your
77100
</Step>
78101
</Steps>
79102

80-
## 3. RAG Server Setup
103+
## 4. RAG Server Setup
81104

82105
<Steps>
83106
<Step title="Deploy LangConnect">
@@ -91,17 +114,18 @@ The next step in setting up Open Agent Platform is to deploy and configure your
91114
</Step>
92115
</Steps>
93116

94-
## 4. MCP Server Setup
117+
## 5. MCP Server Setup
95118

96119
<Tip>
97120
Open Agent Platform only supports connecting to MCP servers which support Streamable HTTP requests.
121+
If you don't have an MCP server set up yet, you can use [Arcade](https://docs.arcade.dev/home/mcp-desktop-clients/vscode-client)'s public beta MCP server.
98122
</Tip>
99123

100124
<Steps>
101125
<Step title="Configure MCP Server URL">
102126
Set your MCP server URL inside the `apps/web/` directory (ensure it does not end with `/mcp`. This will be auto-applied by OAP):
103127
```bash
104-
NEXT_PUBLIC_MCP_SERVER_URL="<your MCP server URL>"
128+
NEXT_PUBLIC_MCP_SERVER_URL="https://api.arcade.dev/v1/mcps/arcade-anon/"
105129
```
106130
</Step>
107131
<Step title="Configure Authentication (if required)">
@@ -112,7 +136,7 @@ The next step in setting up Open Agent Platform is to deploy and configure your
112136
</Step>
113137
</Steps>
114138

115-
## 5. Run Your Platform
139+
## 6. Run Your Platform
116140

117141
Start the application with your configured environment variables:
118142

0 commit comments

Comments
 (0)