Skip to content

Commit 46f6e0b

Browse files
authored
added claude desktop instructions for MCP gateways (#656)
1 parent 26a79bc commit 46f6e0b

15 files changed

Lines changed: 190 additions & 3 deletions

File tree

Lines changed: 190 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,193 @@
1-
import { Steps, Tabs, Callout } from "nextra/components";
1+
import { Steps, Callout } from "nextra/components";
22
import { SignupLink } from "@/app/_components/analytics";
3+
import Image from "next/image";
34

4-
# Use Arcade with Claude Desktop
5+
export const IMAGE_SCALE_FACTOR = 2;
6+
export const STEP_1_DARK_WIDTH = 582;
7+
export const STEP_1_DARK_HEIGHT = 966;
8+
export const STEP_1_LIGHT_WIDTH = 578;
9+
export const STEP_1_LIGHT_HEIGHT = 960;
10+
export const STEP_2_DARK_WIDTH = 2388;
11+
export const STEP_2_DARK_HEIGHT = 1242;
12+
export const STEP_2_LIGHT_WIDTH = 2352;
13+
export const STEP_2_LIGHT_HEIGHT = 1202;
14+
export const STEP_3_DARK_WIDTH = 1104;
15+
export const STEP_3_DARK_HEIGHT = 874;
16+
export const STEP_3_LIGHT_WIDTH = 1094;
17+
export const STEP_3_LIGHT_HEIGHT = 882;
18+
export const STEP_4_DARK_WIDTH = 1860;
19+
export const STEP_4_DARK_HEIGHT = 206;
20+
export const STEP_4_LIGHT_WIDTH = 1826;
21+
export const STEP_4_LIGHT_HEIGHT = 210;
22+
export const STEP_5_DARK_WIDTH = 1208;
23+
export const STEP_5_DARK_HEIGHT = 1696;
24+
export const STEP_5_LIGHT_WIDTH = 1208;
25+
export const STEP_5_LIGHT_HEIGHT = 1696;
26+
export const STEP_6_DARK_WIDTH = 1874;
27+
export const STEP_6_DARK_HEIGHT = 210;
28+
export const STEP_6_LIGHT_WIDTH = 1820;
29+
export const STEP_6_LIGHT_HEIGHT = 216;
30+
export const STEP_7_DARK_WIDTH = 1852;
31+
export const STEP_7_DARK_HEIGHT = 2458;
32+
export const STEP_7_LIGHT_WIDTH = 1848;
33+
export const STEP_7_LIGHT_HEIGHT = 2450;
534

6-
Coming Soon
35+
# Use Arcade in Claude Desktop
36+
37+
<GuideOverview>
38+
<GuideOverview.Outcomes>
39+
40+
Connect Claude Desktop to an Arcade MCP Gateway.
41+
42+
</GuideOverview.Outcomes>
43+
44+
<GuideOverview.Prerequisites>
45+
46+
1. Create an <SignupLink linkLocation="docs:claude-desktop-client">Arcade account</SignupLink>
47+
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
49+
50+
</GuideOverview.Prerequisites>
51+
52+
</GuideOverview>
53+
54+
<Callout type="info">
55+
For Claude Desktop, you need to set the `Authorization` field to `Arcade Auth`
56+
in the dashboard. If you are using the `Arcade Headers` auth mode, you won't
57+
be able to use it with Claude Desktop.
58+
</Callout>
59+
60+
<Steps>
61+
62+
### Go to your Claude Desktop setting page
63+
64+
On the bottom left corner of Claude Desktop, click on your user avatar to open the settings menu, then click on the "Settings" button.
65+
66+
<Image
67+
alt={"Step 1: Click on the settings icon on Claude Desktop"}
68+
className="max-w-full dark:hidden mt-4"
69+
src={"/images/mcp-gateway/claude-desktop/step-1-light.jpg"}
70+
width={STEP_1_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
71+
height={STEP_1_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
72+
/>
73+
<Image
74+
alt={"Step 1: Click on the settings icon on Claude Desktop"}
75+
className="hidden max-w-full dark:block mt-4"
76+
src={"/images/mcp-gateway/claude-desktop/step-1.jpg"}
77+
width={STEP_1_DARK_WIDTH / IMAGE_SCALE_FACTOR}
78+
height={STEP_1_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
79+
/>
80+
81+
### Add a Custom Connector
82+
83+
On the settings page, click on the "Connectors" tab, and then on the "Add custom Connector" button.
84+
85+
<Image
86+
alt={"Step 2: Add a custom connector"}
87+
className="max-w-full dark:hidden mt-4"
88+
src={"/images/mcp-gateway/claude-desktop/step-2-light.jpg"}
89+
width={STEP_2_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
90+
height={STEP_2_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
91+
/>
92+
<Image
93+
alt={"Step 2: Add a custom connector"}
94+
className="hidden max-w-full dark:block mt-4"
95+
src={"/images/mcp-gateway/claude-desktop/step-2.jpg"}
96+
width={STEP_2_DARK_WIDTH / IMAGE_SCALE_FACTOR}
97+
height={STEP_2_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
98+
/>
99+
100+
A modal dialog will open asking you for a name and a URL. Enter a name for your connector, and the URL of your MCP Gateway. Then, click on the "Add" button.
101+
102+
<Image
103+
alt={"Step 3: Enter a name and URL for your connector"}
104+
className="max-w-full dark:hidden mt-4"
105+
src={"/images/mcp-gateway/claude-desktop/step-3-light.jpg"}
106+
width={STEP_3_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
107+
height={STEP_3_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
108+
/>
109+
<Image
110+
alt={"Step 3: Enter a name and URL for your connector"}
111+
className="hidden max-w-full dark:block mt-4"
112+
src={"/images/mcp-gateway/claude-desktop/step-3.jpg"}
113+
width={STEP_3_DARK_WIDTH / IMAGE_SCALE_FACTOR}
114+
height={STEP_3_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
115+
/>
116+
117+
### authenticate with your Arcade account
118+
119+
You will see a new connector added to your list of connectors. Click on the "Connect" button to authenticate with your Arcade account.
120+
121+
<Image
122+
alt={"Step 4: Authenticate with your Arcade account"}
123+
className="max-w-full dark:hidden mt-4"
124+
src={"/images/mcp-gateway/claude-desktop/step-4-light.jpg"}
125+
width={STEP_4_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
126+
height={STEP_4_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
127+
/>
128+
<Image
129+
alt={"Step 4: Authenticate with your Arcade account"}
130+
className="hidden max-w-full dark:block mt-4"
131+
src={"/images/mcp-gateway/claude-desktop/step-4.jpg"}
132+
width={STEP_4_DARK_WIDTH / IMAGE_SCALE_FACTOR}
133+
height={STEP_4_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
134+
/>
135+
136+
Your browser will open a new tab to authenticate with your Arcade account. Check that the URL matches the one in the modal dialog, and then click on the "Allow" button.
137+
138+
<Image
139+
alt={"Step 5: Allow authentication with your Arcade account"}
140+
className="max-w-full dark:hidden mt-4"
141+
src={"/images/mcp-gateway/claude-desktop/step-5-light.jpg"}
142+
width={STEP_5_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
143+
height={STEP_5_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
144+
/>
145+
<Image
146+
alt={"Step 5: Allow authentication with your Arcade account"}
147+
className="hidden max-w-full dark:block mt-4"
148+
src={"/images/mcp-gateway/claude-desktop/step-5.jpg"}
149+
width={STEP_5_DARK_WIDTH / IMAGE_SCALE_FACTOR}
150+
height={STEP_5_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
151+
/>
152+
153+
### Configure the MCP Gateway
154+
155+
Now Claude Desktop is connected to your MCP Gateway, it's a good time to configure the MCP Gateway to your needs. Click on the "Configure" button to open the configuration dialog.
156+
157+
<Image
158+
alt={"Step 6: Configure the MCP Gateway"}
159+
className="max-w-full dark:hidden mt-4"
160+
src={"/images/mcp-gateway/claude-desktop/step-6-light.jpg"}
161+
width={STEP_6_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
162+
height={STEP_6_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
163+
/>
164+
<Image
165+
alt={"Step 6: Configure the MCP Gateway"}
166+
className="hidden max-w-full dark:block mt-4"
167+
src={"/images/mcp-gateway/claude-desktop/step-6.jpg"}
168+
width={STEP_6_DARK_WIDTH / IMAGE_SCALE_FACTOR}
169+
height={STEP_6_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
170+
/>
171+
172+
In this configuration pane, you can configure which tools are available to Claude Desktop, and whether or not they require human confirmation. On this example MCP gateway, we require human confirmation for all tools that may have destructive actions, or actions with potentially undesired consequences.
173+
174+
<Image
175+
alt={"Step 7: Configure the MCP Gateway"}
176+
className="max-w-full dark:hidden mt-4"
177+
src={"/images/mcp-gateway/claude-desktop/step-7-light.jpg"}
178+
width={STEP_7_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
179+
height={STEP_7_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
180+
/>
181+
<Image
182+
alt={"Step 7: Configure the MCP Gateway"}
183+
className="hidden max-w-full dark:block mt-4"
184+
src={"/images/mcp-gateway/claude-desktop/step-7.jpg"}
185+
width={STEP_7_DARK_WIDTH / IMAGE_SCALE_FACTOR}
186+
height={STEP_7_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
187+
/>
188+
189+
### Try it out!
190+
191+
You can now open a new chat within Claude Desktop. Ensure that your connector is enabled, and the ask the agent to use a tool!
192+
193+
</Steps>
112 KB
Loading
119 KB
Loading
275 KB
Loading
278 KB
Loading
235 KB
Loading
249 KB
Loading
45.1 KB
Loading
41.4 KB
Loading
347 KB
Loading

0 commit comments

Comments
 (0)