Skip to content

Commit c7a8c53

Browse files
authored
Update MCP Gateways docs (#623)
* Update with VS Code * update gateway images
1 parent 957deea commit c7a8c53

File tree

17 files changed

+89
-69
lines changed

17 files changed

+89
-69
lines changed

app/en/get-started/quickstarts/call-tool-client/page.mdx

Lines changed: 32 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ import { SignupLink } from "@/app/_components/analytics";
88
import Image from "next/image";
99

1010
export const IMAGE_SCALE_FACTOR = 2;
11-
export const CREATE_MCP_GATEWAY_DARK_WIDTH = 1128;
12-
export const CREATE_MCP_GATEWAY_DARK_HEIGHT = 1644;
13-
export const CREATE_MCP_GATEWAY_LIGHT_WIDTH = 1136;
14-
export const CREATE_MCP_GATEWAY_LIGHT_HEIGHT = 1642;
15-
export const TOOL_PICKER_DARK_WIDTH = 2568;
16-
export const TOOL_PICKER_DARK_HEIGHT = 2174;
17-
export const TOOL_PICKER_LIGHT_WIDTH = 2568;
18-
export const TOOL_PICKER_LIGHT_HEIGHT = 2174;
19-
export const MCP_GATEWAY_URL_DARK_WIDTH = 2406;
20-
export const MCP_GATEWAY_URL_DARK_HEIGHT = 506;
21-
export const MCP_GATEWAY_URL_LIGHT_WIDTH = 2406;
22-
export const MCP_GATEWAY_URL_LIGHT_HEIGHT = 506;
11+
export const CREATE_MCP_GATEWAY_DARK_WIDTH = 921;
12+
export const CREATE_MCP_GATEWAY_DARK_HEIGHT = 1872;
13+
export const CREATE_MCP_GATEWAY_LIGHT_WIDTH = 921;
14+
export const CREATE_MCP_GATEWAY_LIGHT_HEIGHT = 1872;
15+
export const TOOL_PICKER_DARK_WIDTH = 2560;
16+
export const TOOL_PICKER_DARK_HEIGHT = 1518;
17+
export const TOOL_PICKER_LIGHT_WIDTH = 2560;
18+
export const TOOL_PICKER_LIGHT_HEIGHT = 1518;
19+
export const MCP_GATEWAY_URL_DARK_WIDTH = 2834;
20+
export const MCP_GATEWAY_URL_DARK_HEIGHT = 498;
21+
export const MCP_GATEWAY_URL_LIGHT_WIDTH = 2834;
22+
export const MCP_GATEWAY_URL_LIGHT_HEIGHT = 498;
2323

2424
# Call a tool in your IDE/MCP Client
2525

@@ -55,14 +55,14 @@ Create a coding agent using an MCP Gateway to call tools from multiple MCP serve
5555

5656
<Image
5757
alt={"Create MCP Gateway"}
58-
className="max-w-full dark:hidden"
58+
className="max-w-full dark:hidden mt-4"
5959
src={"/images/mcp-gateway/create-mcp-gateway-light.png"}
6060
width={CREATE_MCP_GATEWAY_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
6161
height={CREATE_MCP_GATEWAY_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
6262
/>
6363
<Image
6464
alt={"Create MCP Gateway"}
65-
className="hidden max-w-full dark:block"
65+
className="hidden max-w-full dark:block mt-4"
6666
src={"/images/mcp-gateway/create-mcp-gateway-dark.png"}
6767
width={CREATE_MCP_GATEWAY_DARK_WIDTH / IMAGE_SCALE_FACTOR}
6868
height={CREATE_MCP_GATEWAY_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
@@ -85,27 +85,28 @@ Feel free to select any tools you want to include in your specific use case.
8585

8686
<Image
8787
alt={"Tool Picker"}
88-
className="max-w-full dark:hidden"
89-
src={"/images/mcp-gateway/tool-picker-light.png"}
88+
className="max-w-full dark:hidden mt-4"
89+
src={"/images/mcp-gateway/mcp-gateway-tool-filter-dev-light.png"}
9090
width={TOOL_PICKER_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
9191
height={TOOL_PICKER_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
9292
/>
9393
<Image
9494
alt={"Tool Picker"}
95-
className="hidden max-w-full dark:block"
96-
src={"/images/mcp-gateway/tool-picker-dark.png"}
95+
className="hidden max-w-full dark:block mt-4"
96+
src={"/images/mcp-gateway/mcp-gateway-tool-filter-dev-dark.png"}
9797
width={TOOL_PICKER_DARK_WIDTH / IMAGE_SCALE_FACTOR}
9898
height={TOOL_PICKER_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
9999
/>
100100

101101
Once you've selected the tools you want to include in the gateway, click the "Use N tools" button in the tool picker, and then click the "Create MCP Gateway" button to create the gateway.
102102

103103
<Callout type="info">
104-
There is no limit to the number of tools you can select in an MCP Gateway.
105-
However, be mindful of how the MCP clients will handle the large number of
106-
tools. Some clients may not handle a large number of tools well, and may
107-
consume a significant portion of the LLM's context window. As a rule of thumb,
108-
we recommend keeping the number of tools in a single MCP Gateway below 80.
104+
There is a large limit to the number of tools you can select in an MCP
105+
Gateway. However, be mindful of how the MCP clients will handle the large
106+
number of tools. Some clients may not handle a large number of tools well, and
107+
may consume a significant portion of the LLM's context window. As a rule of
108+
thumb, we recommend keeping the number of tools in a single MCP Gateway below
109+
80.
109110
</Callout>
110111

111112
### Connect the MCP Gateway to an MCP client
@@ -119,15 +120,15 @@ Get the URL of your MCP Gateway by clicking the "Copy URL" button in the MCP Gat
119120

120121
<Image
121122
alt={"MCP Gateway URL"}
122-
className="max-w-full dark:hidden"
123-
src={"/images/mcp-gateway/mcp-url-light.png"}
123+
className="max-w-full dark:hidden mt-4"
124+
src={"/images/mcp-gateway/project-mcp-gateways-light.png"}
124125
width={MCP_GATEWAY_URL_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
125126
height={MCP_GATEWAY_URL_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
126127
/>
127128
<Image
128129
alt={"MCP Gateway URL"}
129-
className="hidden max-w-full dark:block"
130-
src={"/images/mcp-gateway/mcp-url-dark.png"}
130+
className="hidden max-w-full dark:block mt-4"
131+
src={"/images/mcp-gateway/project-mcp-gateways-dark.png"}
131132
width={MCP_GATEWAY_URL_DARK_WIDTH / IMAGE_SCALE_FACTOR}
132133
height={MCP_GATEWAY_URL_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
133134
/>
@@ -157,41 +158,16 @@ Get the URL of your MCP Gateway by clicking the "Copy URL" button in the MCP Gat
157158
</Tabs.Tab>
158159
<Tabs.Tab>
159160

160-
1. Open the command palette and select **MCP: Add Server...**
161+
1. Open the command palette (Mac: Cmd + Shift + p / Windows: Ctrl + Shift + p) and select **MCP: Add Server...**
161162
1. Choose **HTTP**
162-
1. Paste the URL of your MCP Gateway. You may see a warning about Dynamic Client Registration. You can ignore this.
163+
1. Paste the URL of your MCP Gateway.
163164
1. Give your MCP server a name, like `mcp-arcade`
164-
1. 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
165-
166-
Visual Studio Code will update your `mcp.json` file, but you will manually need to add the headers above:
167-
168-
```json
169-
{
170-
"servers": {
171-
"mcp-arcade": {
172-
"url": "https://api.arcade.dev/mcp/<YOUR-GATEWAY-SLUG>",
173-
"type": "http",
174-
"headers": {
175-
"Authorization": "Bearer {arcade_api_key}",
176-
"Arcade-User-ID": "{arcade_user_id}"
177-
}
178-
}
179-
}
180-
}
181-
```
165+
1. Visual Studio Code will update your `mcp.json` file.
166+
1. Either in the `mcp.json` file or in the "Extensions" > "MCP Servers - Installed" pane, click the "Start" button next to your MCP server and follow the prompts to authenticate.
182167

183168
</Tabs.Tab>
184169
</Tabs>
185170

186-
<Callout type="info">
187-
You can get an API key from the dashboard, following these instructions:
188-
[Getting Your API Key](/get-started/setup/api-keys).
189-
190-
The user ID is the email address that
191-
you used to sign up for the Arcade account.
192-
193-
</Callout>
194-
195171
### Try it out
196172

197173
1. Open your IDE's chat pane.

app/en/guides/create-tools/mcp-gateways/page.mdx

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ title: "MCP Gateways"
33
description: "Comprehensive guide to using MCP Gateways"
44
---
55

6+
import Image from "next/image";
7+
8+
export const IMAGE_SCALE_FACTOR = 2;
9+
export const TOOL_FILTER_LIGHT_WIDTH = 2052;
10+
export const TOOL_FILTER_LIGHT_HEIGHT = 1412;
11+
export const TOOL_FILTER_DARK_WIDTH = 2052;
12+
export const TOOL_FILTER_DARK_HEIGHT = 1412;
13+
614
# MCP Gateways
715

816
MCP Gateways are a way to connect multiple MCP Servers to your agent, application, or IDE. MCP Gateways allow you to federate the tools from multiple MCP Servers into a single collection for easier management, control, and access. 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.
@@ -13,14 +21,31 @@ To configure an MCP Gateway, go to the [MCP Gateways dashboard](https://api.arca
1321

1422
When configuring an MCP Gateway, you can select the tools you want to include in the Gateway from any MCP Servers available to the project:
1523

16-
![MCP Gateway Configuration](/images/mcp-gateway-configuration.png)
24+
<Image
25+
alt={"MCP Gateway Tool Filter"}
26+
className="max-w-full dark:hidden mt-4"
27+
src={"/images/mcp-gateway-tool-filter-light.png"}
28+
width={TOOL_FILTER_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
29+
height={TOOL_FILTER_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
30+
/>
31+
<Image
32+
alt={"MCP Gateway Tool Filter"}
33+
className="hidden max-w-full dark:block mt-4"
34+
src={"/images/mcp-gateway-tool-filter-dark.png"}
35+
width={TOOL_FILTER_DARK_WIDTH / IMAGE_SCALE_FACTOR}
36+
height={TOOL_FILTER_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
37+
/>
1738

1839
The options available when configuring an MCP Gateway are:
1940

2041
- **Name**: The name of the MCP Gateway. Informative only.
21-
- **Description**: The description of the MCP Gateway. If set, this information will be returned to the LLM to hint at the purpose of the tools within the MCP Gateway.
42+
- **Description**: The description of the MCP Gateway. This is useful for humans and some MCP clients may surface this information to the user.
43+
- **LLM Instructions**: Optional instructions for the LLM about how to use the MCP Gateway.
2244
- **Slug**: The slug of the MCP Gateway. This is the URL slug that will be used to access the MCP Gateway. It must be unique.
23-
- **Allowed Tools**: If set, only the tools in the MCP Servers that are selected will be available to the MCP Gateway. If left blank, all tools from the MCP Servers available to the project will be available through the MCP Gateway.
45+
- **Authentication**: The authentication mode to use for the MCP Gateway. This determines how the MCP Gateway will authenticate requests to the MCP Servers. Users will still need to authenticate to the tools within the MCP Gateway as normal.
46+
- **Arcade Auth**: To access the MCP Gateway, you'll need to authenticate with your Arcade account. We recommend using this authentication mode for MCP Gateways in development or testing phase, or for internal use when you know all the users will have Arcade accounts.
47+
- **Arcade Headers**: To access the MCP Gateway, you'll need to authenticate with your Arcade account by passing an Arcade API key in the `Authorization` header and the user ID of your end-user in the `Arcade-User-ID` header. We recommend using this authentication mode for MCP Gateways in production when your agent or application has users without Arcade accounts.
48+
- **Allowed Tools**: A selection of tools in the Arcade Tool Catalog that will be available to the MCP Gateway.
2449

2550
## How to use MCP Gateways
2651

app/en/guides/tool-calling/mcp-clients/visual-studio-code/page.mdx

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,38 @@ In this guide, you'll learn how to connect Visual Studio Code to an Arcade MCP G
1010
### Prerequisites
1111

1212
1. Create an <SignupLink linkLocation="docs:claude-desktop-client">Arcade account</SignupLink>
13-
2. Get an [Arcade API key](/get-started/setup/api-keys)
14-
3. Create an [Arcade MCP Gateway](/guides/create-tools/mcp-gateways) and select the tools you want to use
13+
2. Create an [Arcade MCP Gateway](/guides/create-tools/mcp-gateways) and select the tools you want to use
1514

1615
### Set up Visual Studio Code
1716

18-
3. Download and open [Visual Studio Code](https://code.visualstudio.com/download) (version 1.100.0 or higher)
17+
3. Download and open [Visual Studio Code](https://code.visualstudio.com/download) (version 1.107.0 or higher)
1918
4. Open the command palette and select **MCP: Add Server...**
2019
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.
20+
6. Paste the URL of your MCP Gateway.
2221
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
2422

25-
Visual Studio Code will update your `mcp.json` file, but you will manually need to add the headers above:
23+
Visual Studio Code will update your `mcp.json` file.
24+
25+
### Start the MCP Server in Visual Studio Code
26+
27+
8. In the `mcp.json` file or in the "Extensions" > "MCP Servers - Installed" pane, click the "Start" button next to your MCP server.
28+
9. Visual Studio Code will prompt you to authenticate, and you may see a prompt about opening an external site: `cloud.arcade.dev`. You can safely allow both of these.
29+
10. If you see an Arcade login screen, authenticate with your Arcade account.
30+
11. You should see an Arcade consent screen asking you to authorize Visual Studio Code to access your Arcade account. Click "Allow" to continue.
31+
12. You should then see a webpage from Visual Studio Code saying the sign in was successful. You may see a prompt from your browser to open a link in Visual Studio Code. You can safely allow this.
32+
33+
Your MCP Server should now be running and you can use it in Visual Studio Code.
34+
35+
### Try it out
36+
37+
13. Open your IDE's chat pane.
38+
14. Make sure you are in **Agent** mode
39+
15. Ask the agent to use a tool!
40+
41+
</Steps>
42+
43+
44+
Note: if you are using the Arcade Header auth mode for your MCP Gateway, you will manually need to add the headers property in your `mcp.json` file:
2645

2746
```json
2847
{
@@ -39,4 +58,4 @@ Visual Studio Code will update your `mcp.json` file, but you will manually need
3958
}
4059
```
4160

42-
</Steps>
61+
You will not see the authentication prompts when you start the MCP Server in Visual Studio Code because the API Key is passed directly.

app/en/resources/glossary/page.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,8 +177,8 @@ To set your own credentials, set the requisite secret within the Arcade Dashboar
177177
```mermaid
178178
graph TD
179179
A[Agent] --> B[Arcade Client]
180-
B --> C[Arcade Engine]
181-
C --> D[MCP Gateway]
180+
B --> C[MCP Gateway]
181+
C --> D[Arcade Engine]
182182
D --> E[MCP Server]
183183
```
184184

@@ -196,7 +196,7 @@ The Arcade Engine is also responsible for the OAuth flow for your agent's users.
196196

197197
### MCP Gateway
198198

199-
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.
199+
MCP Gateways are a feature of the Arcade Engine that allows you to add and combine multiple MCP servers in your project. It allows your clients to speak MCP directly to Arcade and get all the functionality you'd expect from the Arcade Engine. 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 agent or LLM.
200200

201201
### Arcade MCP (Server Development Kit)
202202

-317 KB
Binary file not shown.
153 KB
Loading
159 KB
Loading
-68.1 KB
Loading
-68.9 KB
Loading
149 KB
Loading

0 commit comments

Comments
 (0)