Skip to content

Commit 46e8d6c

Browse files
Update MCP Gateway docs (#690)
* Update MCP Gateway docs * Update comment * 🤖 Regenerate LLMs.txt * Update app/en/guides/mcp-gateways/create-via-ai/page.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update app/en/guides/mcp-gateways/create-via-ai/page.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update app/en/guides/mcp-gateways/create-via-dashboard/page.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update app/en/guides/mcp-gateways/create-via-dashboard/page.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update app/en/guides/mcp-gateways/create-via-dashboard/page.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update app/en/guides/mcp-gateways/page.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update app/en/guides/mcp-gateways/create-via-dashboard/page.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 1c443db commit 46e8d6c

14 files changed

Lines changed: 197 additions & 24 deletions

File tree

app/en/get-started/mcp-clients/claude-desktop/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Connect Claude Desktop to an Arcade MCP Gateway.
4545

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

5050
</GuideOverview.Prerequisites>
5151

app/en/get-started/mcp-clients/copilot-studio/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Connect Microsoft Copilot Studio to an Arcade MCP Gateway.
2626
1. A Microsoft 365 subscription with access to Copilot Studio
2727
2. Create an <SignupLink linkLocation="docs:copilot-studio-client">Arcade account</SignupLink>
2828
3. Get an [Arcade API key](/get-started/setup/api-keys)
29-
4. Create an [Arcade MCP Gateway](/guides/create-tools/mcp-gateways) and select the tools you want to use
29+
4. Create an [Arcade MCP Gateway](/guides/mcp-gateways) and select the tools you want to use
3030

3131
</GuideOverview.Prerequisites>
3232

app/en/get-started/mcp-clients/cursor/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Connect Cursor to an Arcade MCP Gateway.
1414

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

1919
</GuideOverview.Prerequisites>
2020

app/en/get-started/mcp-clients/visual-studio-code/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ 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. 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/mcp-gateways) and select the tools you want to use
1414

1515
### Set up Visual Studio Code
1616

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ As you interact with the agent, it will call the tools from the MCP Gateway. You
147147

148148
## Next Steps
149149

150-
- Learn more about [MCP Gateways](/guides/create-tools/mcp-gateways).
150+
- Learn more about [MCP Gateways](/guides/mcp-gateways).
151151
- Learn how to use MCP Gateways with:
152152
- [Cursor](/get-started/mcp-clients/cursor)
153153
- [Visual Studio Code](/get-started/mcp-clients/visual-studio-code)

app/en/guides/_meta.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
import type { MetaRecord } from "nextra";
22

33
export const meta: MetaRecord = {
4+
"mcp-gateways": {
5+
title: "MCP Gateways",
6+
},
47
"tool-calling": {
58
title: "Call tools",
69
},

app/en/guides/deployment-hosting/arcade-deploy/page.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,11 +148,11 @@ Navigate to the [Servers](https://api.arcade.dev/dashboard/servers) page in your
148148
- Test and execute all the tools
149149
- Manage users connected to the Auth providers
150150
- Manage the secrets for the server
151-
- Create [MCP Gateways](/guides/create-tools/mcp-gateways)
151+
- Create [MCP Gateways](/guides/mcp-gateways)
152152
153153
## Create an MCP Gateway to call the tools in your MCP Server
154154
155-
Once the MCP server is deployed to Arcade, all the tools in the server will be available in the [tool catalog](https://api.arcade.dev/dashboard/tools) page in your Arcade dashboard. To call the tools from an MCP client, you first need to [create an MCP Gateway](/guides/create-tools/mcp-gateways) to pick and choose which tools you want to use in your MCP clients.
155+
Once the MCP server is deployed to Arcade, all the tools in the server will be available in the [tool catalog](https://api.arcade.dev/dashboard/tools) page in your Arcade dashboard. To call the tools from an MCP client, you first need to [create an MCP Gateway](/guides/mcp-gateways) to pick and choose which tools you want to use in your MCP clients.
156156
157157
When creating an MCP gateway, you can select the tools you want to include in the Gateway from any MCP Servers available to the project, including the one you just deployed.
158158
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import type { MetaRecord } from "nextra";
2+
3+
export const meta: MetaRecord = {
4+
"create-via-dashboard": {
5+
title: "Create via Dashboard",
6+
},
7+
"create-via-ai": {
8+
title: "Create via AI Assistant",
9+
},
10+
};
11+
12+
export default meta;
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: "Arcade Gateway Assistant"
3+
description: "Create and manage MCP Gateways using AI directly from your chat interface"
4+
---
5+
6+
import { Callout, Steps } from "nextra/components";
7+
import { SignupLink } from "@/app/_components/analytics";
8+
9+
# Arcade Gateway Assistant
10+
11+
<GuideOverview>
12+
<GuideOverview.Outcomes>
13+
14+
Create and manage MCP Gateways directly from your chat interface using natural language.
15+
16+
</GuideOverview.Outcomes>
17+
18+
<GuideOverview.Prerequisites>
19+
20+
1. Create an <SignupLink linkLocation="docs:gateway-assistant">Arcade account</SignupLink>
21+
2. An MCP-compatible chat client ([Cursor](/get-started/mcp-clients/cursor), [Claude Desktop](/get-started/mcp-clients/claude-desktop), [VS Code](/get-started/mcp-clients/visual-studio-code), etc.)
22+
23+
</GuideOverview.Prerequisites>
24+
25+
</GuideOverview>
26+
27+
## Setup
28+
29+
<Steps>
30+
31+
### Connect to the Gateway Assistant
32+
33+
The Gateway Assistant is an MCP server that lets you create and manage MCP Gateways. To use it, add the Arcade Gateway Assistant (using Arcade Auth) to your MCP client using this URL:
34+
35+
```
36+
https://ctl.arcade.dev/mcp
37+
```
38+
39+
<Callout type="info">
40+
The Gateway Assistant uses **Arcade Auth**. This means you'll authenticate with your Arcade account to access the assistant.
41+
</Callout>
42+
43+
Each MCP client has a different setup process. See [Connect to MCP clients](/get-started/mcp-clients) for detailed instructions for adding the Gateway Assistant to Cursor, Claude Desktop, VS Code, and other supported clients with Arcade Auth.
44+
45+
### Authenticate
46+
47+
When you first use the Gateway Assistant, the system will prompt you to authenticate with your Arcade account. This is a one-time setup that allows the assistant to create and manage gateways on your behalf.
48+
49+
### Start creating gateways
50+
51+
Ask your AI assistant to create a gateway by describing what you want to do. For example:
52+
53+
> "I want to send emails with Gmail and manage my calendar with Google Calendar. Create a gateway for this."
54+
55+
> "Create a gateway that lets me manage GitHub PRs and post updates to Slack."
56+
57+
The assistant will select the appropriate tools from Arcade's catalog and create a gateway for you.
58+
59+
</Steps>
60+
61+
{/* TODO: Add video embed showing the full flow once it is posted to YouTube*/}
62+
63+
## After Creating a Gateway
64+
65+
Once you've created a gateway, you'll need to add it to your chat client as a separate MCP server. The assistant will provide your new gateway's MCP URL (for example, `https://api.arcade.dev/mcp/<YOUR-GATEWAY-SLUG>`).
66+
67+
Follow the same process you used to add the Gateway Assistant - see [Connect to MCP clients](/get-started/mcp-clients) for setup instructions specific to your client.
68+
69+
<Callout type="info">
70+
The Gateway Assistant creates gateways that use **Arcade Auth** by default. This means you'll authenticate with your Arcade account to access the gateway. For production use cases with end users who don't have Arcade accounts, you can modify the gateway's authentication settings in the [dashboard](https://api.arcade.dev/dashboard/mcp-gateways).
71+
</Callout>
Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,37 @@
11
---
2-
title: "MCP Gateways"
3-
description: "Comprehensive guide to using MCP Gateways"
2+
title: "Create via Dashboard"
3+
description: "Create and configure MCP Gateways using the Arcade dashboard"
44
---
55

66
import Image from "next/image";
7+
import { SignupLink } from "@/app/_components/analytics";
78

89
export const IMAGE_SCALE_FACTOR = 2;
910
export const TOOL_FILTER_LIGHT_WIDTH = 2052;
1011
export const TOOL_FILTER_LIGHT_HEIGHT = 1412;
1112
export const TOOL_FILTER_DARK_WIDTH = 2052;
1213
export const TOOL_FILTER_DARK_HEIGHT = 1412;
1314

14-
# MCP Gateways
15+
# Create via Dashboard
1516

16-
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.
17+
<GuideOverview>
18+
<GuideOverview.Outcomes>
1719

18-
## Configure MCP Gateways
20+
Create and configure an MCP Gateway using the Arcade dashboard with full control over settings.
1921

20-
To configure an MCP Gateway, go to the [MCP Gateways dashboard](https://api.arcade.dev/dashboard/mcp-gateways) and click on the "Create MCP Gateway" button.
22+
</GuideOverview.Outcomes>
23+
24+
<GuideOverview.Prerequisites>
25+
26+
1. Create an <SignupLink linkLocation="docs:mcp-gateways-dashboard">Arcade account</SignupLink>
27+
28+
</GuideOverview.Prerequisites>
29+
30+
</GuideOverview>
31+
32+
## Create a Gateway
33+
34+
To create an MCP Gateway, go to the [MCP Gateways dashboard](https://api.arcade.dev/dashboard/mcp-gateways) and click the "Create MCP Gateway" button.
2135

2236
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:
2337

@@ -36,21 +50,21 @@ When configuring an MCP Gateway, you can select the tools you want to include in
3650
height={TOOL_FILTER_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
3751
/>
3852

53+
## Configuration Options
54+
3955
The options available when configuring an MCP Gateway are:
4056

4157
- **Name**: The name of the MCP Gateway. Informative only.
4258
- **Description**: The description of the MCP Gateway. This is useful for humans and some MCP clients may surface this information to the user.
4359
- **LLM Instructions**: Optional instructions for the LLM about how to use the MCP Gateway.
4460
- **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.
4561
- **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.
62+
- **Arcade Auth**: To access the MCP Gateway, you'll need to authenticate with your Arcade account. This authentication mode is recommended for MCP Gateways in development or testing phase, or for internal use when you know all the users will have Arcade accounts.
63+
- **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. This authentication mode is recommended for MCP Gateways in production when your agent or application has users without Arcade accounts.
4864
- **Allowed Tools**: A selection of tools in the Arcade Tool Catalog that will be available to the MCP Gateway.
4965

50-
## How to use MCP Gateways
66+
## After Creating a Gateway
5167

52-
Any MCP client that supports the Streamable HTTP transport can use an Arcade MCP Gateway. To use an Arcade MCP Gateway, you can use the `https://api.arcade.dev/mcp/<YOUR-GATEWAY-SLUG>` URL in your MCP client. Learn how to use MCP Gateways with:
68+
Once you've created a gateway, you'll need to add it to your chat client. The assistant will provide the MCP URL (for example, `https://api.arcade.dev/mcp/<YOUR-GATEWAY-SLUG>`).
5369

54-
- [Cursor](/get-started/mcp-clients/cursor)
55-
- [Claude Desktop](/get-started/mcp-clients/claude-desktop)
56-
- [Visual Studio Code](/get-started/mcp-clients/visual-studio-code)
70+
See [Connect to MCP clients](/get-started/mcp-clients) for setup instructions specific to your client.

0 commit comments

Comments
 (0)