Skip to content

Commit ecae0b2

Browse files
evantahlernbarbettinitorresmateo
authored
Update MCP client docs for MCP gateways (#486)
* Update MCP client docs for MCP gateways * Update app/en/home/glossary/page.mdx Co-authored-by: Nate Barbettini <[email protected]> * Update app/en/home/glossary/page.mdx Co-authored-by: Nate Barbettini <[email protected]> * Apply suggestion from @nbarbettini Co-authored-by: Nate Barbettini <[email protected]> * Update app/en/home/glossary/page.mdx Co-authored-by: Nate Barbettini <[email protected]> * remove duplicated entry in the meta file * axing try it out section --------- Co-authored-by: Nate Barbettini <[email protected]> Co-authored-by: Mateo Torres <[email protected]> Co-authored-by: Mateo Torres <[email protected]>
1 parent 512704a commit ecae0b2

File tree

5 files changed

+93
-75
lines changed

5 files changed

+93
-75
lines changed

app/en/home/glossary/page.mdx

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,8 @@ To set your own credentials, set the requisite secret within the Arcade Dashboar
140140
graph TD
141141
A[Agent] --> B[Arcade Client]
142142
B --> C[Arcade Engine]
143-
C --> D[Worker]
143+
C --> D[MCP Gateway]
144+
D --> E[MCP Server]
144145
```
145146

146147
### Arcade Client
@@ -155,17 +156,15 @@ The Arcade Engine is the core of the Arcade platform. It is responsible for rout
155156

156157
The Arcade Engine is also responsible for the OAuth flow for your agent's users. This includes granting and elevating permissions and keeping tokens fresh.
157158

158-
### Worker
159+
### MCP Gateway
159160

160-
A 'worker' is a process that runs all the tools with a MCP Server. Workers are microservices that are called by the Arcade Engine to handle tool execution requests. Workers are either [deployed to Arcade's infrastructure](/home/serve-tools/arcade-deploy) via `arcade deploy`, or run in your own infrastructure.
161+
MCP gateways are a feature of the Arcade Engine that allows you to add and combine multiple MCP servers in your project. The MCP gateway is responsible for routing tool execution requests to the correct MCP server, and for enforcing security and authorization decisions. You can mix and match tools from different MCP servers in the same project, and not all tools from a MCP server need to be available to the same LLM.
161162

162-
_Learn more about workers [here](/home/deployment/on-prem-mcp)._
163+
### Arcade MCP (Server Development Kit)
163164

164-
### TDK (Tool Development Kit)
165+
Arcade MCP is a framework for building secure MCP servers. It is responsible for the lifecycle of tool executions, and for enforcing security and authorization decisions within the boundary of the server.
165166

166-
The Arcade TDK is a command-line application that helps you create, test, and deploy tools.
167-
168-
_Learn more about the TDK [here](/home/build-tools/create-a-mcp-server)._
167+
_Learn more about the Arcade MCP framework [here](/references)._
169168

170169
### Evaluations (Evals)
171170

app/en/home/mcp-clients/_meta.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export default {
2+
cursor: "Cursor",
23
"claude-desktop": "Claude Desktop",
34
"visual-studio-code": "Visual Studio Code",
4-
cursor: "Cursor",
55
};

app/en/home/mcp-clients/claude-desktop/page.mdx

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,27 @@ In this guide, you'll learn how to connect Claude Desktop to a local Arcade serv
1111

1212
1. Create an <SignupLink linkLocation="docs:claude-desktop-client">Arcade account</SignupLink>
1313
2. Get an [Arcade API key](/home/api-keys)
14-
3. Install **Python 3.10** or higher <br/> Verify your Python version by running `python --version` or `python3 --version` in your terminal.
15-
16-
### Install Dependencies
17-
18-
```bash
19-
pip install arcade-ai
20-
pip install arcade-google
21-
```
22-
23-
<Callout type="info">
24-
See more of Arcade's [MCP Servers](/mcp-servers) that can be installed.
25-
</Callout>
14+
3. Create an [Arcade MCP Gateway](https://api.arcade.dev/dashboard/mcp-gateways)
2615

2716
### Set up Claude Desktop
2817

2918
1. Download and open [Claude Desktop](https://claude.ai/download)
3019
2. Claude Menu --> "Settings" --> "Developer" --> "Edit Config"
31-
3. This will create a configuration file at:
32-
- On Mac: `~/Library/Application Support/Claude/claude_desktop_config.json`
33-
- On Windows: `%APPDATA%\Claude\claude_desktop_config.json`
20+
3. Follow the guide [here](https://support.claude.com/en/articles/11175166-getting-started-with-custom-connectors-using-remote-mcp)
3421
4. Open the configuration file and replace the file contents with this:
35-
36-
Replace `YOUR_ARCADE_API_KEY_HERE` with your actual Arcade API key and `/path/to/python` with the path to your Python interpreter and `/path/to/arcade` with the path to the Arcade package.
22+
* Give your MCP server a name, like `mcp-arcade`
23+
* Use the the URL of your MCP Gateway.
24+
* Add the API key as the bearer token within the `Authorization` header, and the email address that you used to sign up for the Arcade account as the `Arcade-User-ID` header
3725

3826
```json
3927
{
4028
"mcpServers": {
41-
"arcade-stdio": {
42-
"command": "bash",
43-
"args": [
44-
"-c",
45-
"export ARCADE_API_KEY=YOUR_ARCADE_API_KEY_HERE && /path/to/python /path/to/arcade serve --mcp"
46-
]
29+
"arcade-mcp": {
30+
"url": "https://api.arcade.dev/mcp/<YOUR-GATEWAY-SLUG>",
31+
"headers": {
32+
"Authorization": "Bearer {arcade_api_key}",
33+
"Arcade-User-ID": "{arcade_user_id}"
34+
}
4735
}
4836
}
4937
}
Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,48 @@
1-
Coming soon...
1+
import { Steps, Callout } from "nextra/components";
2+
import { SignupLink } from "@/app/_components/analytics";
3+
4+
5+
# Use Arcade in Cursor
6+
7+
In this guide, you'll learn how to connect Cursor to an Arcade MCP Gateway.
8+
9+
<Steps>
10+
11+
### Prerequisites
12+
13+
1. Create an <SignupLink linkLocation="docs:claude-desktop-client">Arcade account</SignupLink>
14+
2. Get an [Arcade API key](/home/api-keys)
15+
3. Create an [Arcade MCP Gateway](https://api.arcade.dev/dashboard/mcp-gateways)
16+
17+
### Set up Cursor
18+
19+
3. Download and open [Cursor](https://cursor.com/download)
20+
4. Open the command palette and select **Open MCP Settings...**
21+
5. Choose **HTTP**
22+
6. Paste the URL of your MCP Gateway
23+
7. Give your MCP server a name, like `mcp-arcade`
24+
8. Add the API key as the bearer token within the `Authorization` header, and the email address that you used to sign up for the Arcade account as the `Arcade-User-ID` header
25+
26+
Cursor will update your `settings.json` file with the following
27+
28+
```json
29+
{
30+
"mcpServers": {
31+
"mcp-arcade": {
32+
"url": "https://api.arcade.dev/mcp/<YOUR-GATEWAY-SLUG>",
33+
"headers": {
34+
"Authorization": "Bearer {arcade_api_key}",
35+
"Arcade-User-ID": "{arcade_user_id}"
36+
}
37+
}
38+
}
39+
}
40+
```
41+
42+
### Try it out
43+
44+
1. Open the chat pane (typically command-l)
45+
1. Make sure you are in **Agent** mode
46+
1. Ask the agent to use a tool!
47+
48+
</Steps>
Lines changed: 26 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,42 @@
11
import { Steps, Callout } from "nextra/components";
2+
import { SignupLink } from "@/app/_components/analytics";
23

34
# Use Arcade in Visual Studio Code
45

5-
In this guide, you'll learn how to connect Visual Studio Code to Arcade.dev's MCP server.
6-
7-
<Callout>
8-
As of version 1.100.0, Visual Studio Code does not yet support [MCP
9-
authorization](https://modelcontextprotocol.io/specification/draft/basic/authorization).
10-
Only tools that do not require auth, such as math and
11-
[search](/mcp-servers/search/google_search) tools, will work with Visual
12-
Studio Code. We're working to improve this - stay tuned!
13-
</Callout>
6+
In this guide, you'll learn how to connect Visual Studio Code to an Arcade MCP Gateway.
147

158
<Steps>
169

17-
### Set up Visual Studio Code
10+
### Prerequisites
1811

19-
1. Download and open [Visual Studio Code](https://code.visualstudio.com/download) (version 1.100.0 or higher)
20-
1. Open the command palette and select **MCP: Add Server...**
21-
1. Choose **HTTP**
22-
1. Paste the following URL: `https://api.arcade.dev/v1/mcps/arcade-anon/mcp`
12+
1. Create an <SignupLink linkLocation="docs:claude-desktop-client">Arcade account</SignupLink>
13+
2. Get an [Arcade API key](/home/api-keys)
14+
3. Create an [Arcade MCP Gateway](https://api.arcade.dev/dashboard/mcp-gateways)
2315

24-
<Callout type="info">
25-
This URL is Arcade's public beta MCP server. We'd love to [hear your
26-
feedback](/home/contact-us)! Coming soon: deploy a server with your own
27-
tools.
28-
</Callout>
16+
### Set up Visual Studio Code
2917

30-
1. Give your MCP server a name, like `mcp-arcade-dev`
18+
3. Download and open [Visual Studio Code](https://code.visualstudio.com/download) (version 1.100.0 or higher)
19+
4. Open the command palette and select **MCP: Add Server...**
20+
5. Choose **HTTP**
21+
6. Paste the URL of your MCP Gateway. You may see a warning about Dynamic Client Registration. You can ignore this.
22+
7. Give your MCP server a name, like `mcp-arcade`
23+
8. Add the API key as the bearer token within the `Authorization` header, and the email address that you used to sign up for the Arcade account as the `Arcade-User-ID` header
3124

32-
Visual Studio Code will update your `settings.json` file with the following:
25+
Visual Studio Code will update your `mcp.json` file, but you will manually need to add the headers above:
3326

3427
```json
35-
"mcp": {
36-
"servers": {
37-
"mcp-arcade-dev": {
38-
"url": "https://api.arcade.dev/v1/mcps/arcade-anon/mcp"
39-
}
40-
}
41-
},
28+
{
29+
"servers": {
30+
"mcp-arcade": {
31+
"url": "https://api.arcade.dev/mcp/<YOUR-GATEWAY-SLUG>",
32+
"type": "http",
33+
"headers": {
34+
"Authorization": "Bearer {arcade_api_key}",
35+
"Arcade-User-ID": "{arcade_user_id}"
36+
}
37+
}
38+
}
39+
}
4240
```
4341

44-
### Try it out
45-
46-
1. Open the chat pane (typically Cmd-Shift-I or Ctrl-Shift-I)
47-
1. Make sure you are in **Agent** mode
48-
1. Click the 🛠️ Tools button, which opens a panel of available tools
49-
1. Click to select the tools you want to use, and type your request in the chat pane!
50-
51-
<div className="flex justify-center my-4">
52-
<img
53-
src="/videos/vscode_mcp_demo.webp"
54-
alt="Visual Studio Code tools panel"
55-
/>
56-
</div>
57-
5842
</Steps>

0 commit comments

Comments
 (0)