Skip to content

Commit a16b64e

Browse files
torresmateovfanellenearestnabors
authored
mcp gateway quickstart (#586)
* mcp gateway quickstart * added next steps to the mcp gateway quickstarter * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: vfanelle <vfanelle@gmail.com> * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: RL "Nearest" Nabors <236306+nearestnabors@users.noreply.github.com> * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: RL "Nearest" Nabors <236306+nearestnabors@users.noreply.github.com> * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: RL "Nearest" Nabors <236306+nearestnabors@users.noreply.github.com> * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: vfanelle <vfanelle@gmail.com> * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: vfanelle <vfanelle@gmail.com> * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: RL "Nearest" Nabors <236306+nearestnabors@users.noreply.github.com> * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: vfanelle <vfanelle@gmail.com> * implemented comments * Update app/en/home/mcp-gateway-quickstart/page.mdx Co-authored-by: vfanelle <vfanelle@gmail.com> * fix broken link and improve the intro * fix title and next steps --------- Co-authored-by: vfanelle <vfanelle@gmail.com> Co-authored-by: RL "Nearest" Nabors <236306+nearestnabors@users.noreply.github.com>
1 parent 7d26f18 commit a16b64e

File tree

8 files changed

+213
-0
lines changed

8 files changed

+213
-0
lines changed

app/en/home/_meta.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ export const meta: MetaRecord = {
4242
quickstart: {
4343
title: "Hosted Tools Quickstart",
4444
},
45+
"mcp-gateway-quickstart": {
46+
title: "Call a tool in your IDE/MCP Client",
47+
},
4548
"custom-mcp-server-quickstart": {
4649
title: "Build MCP Server QuickStart",
4750
},
Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
---
2+
title: "Call a tool in your IDE/MCP Client"
3+
description: "Learn how to call tools in 3rd party agents, apps, or IDEs"
4+
---
5+
6+
import { Steps, Tabs, Callout } from "nextra/components";
7+
import { SignupLink } from "@/app/_components/analytics";
8+
import Image from "next/image";
9+
10+
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;
23+
24+
# Calling tools in 3rd party agents, apps, or IDEs with Arcade
25+
26+
Tools enable your AI agents to perform actions on your behalf. For specific workflows and use cases, this may involve calling tools from multiple MCP servers. Arcade facilitates this by allowing you to create MCP Gateways to federate the tools from multiple MCP servers into a single collection for easier management, control, and access. For example, if your agent specializes in solving specific tickets in Linear, you may want to use tools from the GitHub, Slack and Linear servers in your agent. These add up to 88 tools, which could be overwhelming for an LLM to use effectively. What you want is to get from these servers only the tools that matter for your agent. An MCP Gateway allows you to do just that: pick only the tools required for this workflow, and you can connect it to any MCP client, making it easy to port your agent to multiple platforms and IDEs, and even share it with other users.
27+
28+
<GuideOverview>
29+
<GuideOverview.Outcomes>
30+
31+
Create a coding agent using an MCP Gateway to call tools from multiple MCP servers.
32+
33+
</GuideOverview.Outcomes>
34+
35+
<GuideOverview.Prerequisites>
36+
37+
- An <SignupLink linkLocation="docs:call-tools-directly">Arcade account</SignupLink>
38+
39+
</GuideOverview.Prerequisites>
40+
41+
<GuideOverview.YouWillLearn>
42+
43+
- Create an MCP Gateway
44+
- Connect the MCP Gateway to Cursor or VS Code
45+
- Call tools from the MCP Gateway in your agent
46+
47+
</GuideOverview.YouWillLearn>
48+
</GuideOverview>
49+
50+
<Steps>
51+
52+
### Create an MCP Gateway
53+
54+
**Create a new MCP Gateway.** Go to the [MCP Gateways dashboard](https://api.arcade.dev/dashboard/mcp-gateways), and click on the "Create MCP Gateway" button.
55+
56+
<Image
57+
alt={"Create MCP Gateway"}
58+
className="max-w-full dark:hidden"
59+
src={"/images/mcp-gateway/create-mcp-gateway-light.png"}
60+
width={CREATE_MCP_GATEWAY_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
61+
height={CREATE_MCP_GATEWAY_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
62+
/>
63+
<Image
64+
alt={"Create MCP Gateway"}
65+
className="hidden max-w-full dark:block"
66+
src={"/images/mcp-gateway/create-mcp-gateway-dark.png"}
67+
width={CREATE_MCP_GATEWAY_DARK_WIDTH / IMAGE_SCALE_FACTOR}
68+
height={CREATE_MCP_GATEWAY_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
69+
/>
70+
71+
Give your MCP gateway:
72+
73+
- A name
74+
- A description
75+
- A slug (this is recommended so it's easy to remember and share, but will be generated if left blank)
76+
77+
### Select the tools you want to include in the gateway
78+
79+
**Click the "Select Tools" button** in the form to select the tools you want to include in the gateway. You can select tools from any MCP server available to the active project. For this example, select the following tools:
80+
81+
- the GitHub MCP server
82+
- the Linear MCP server
83+
84+
Feel free to select any tools you want to include in your specific use case.
85+
86+
<Image
87+
alt={"Tool Picker"}
88+
className="max-w-full dark:hidden"
89+
src={"/images/mcp-gateway/tool-picker-light.png"}
90+
width={TOOL_PICKER_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
91+
height={TOOL_PICKER_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
92+
/>
93+
<Image
94+
alt={"Tool Picker"}
95+
className="hidden max-w-full dark:block"
96+
src={"/images/mcp-gateway/tool-picker-dark.png"}
97+
width={TOOL_PICKER_DARK_WIDTH / IMAGE_SCALE_FACTOR}
98+
height={TOOL_PICKER_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
99+
/>
100+
101+
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.
102+
103+
<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.
109+
</Callout>
110+
111+
### Connect the MCP Gateway to an MCP client
112+
113+
Arcade MCP Gateways are compatible with any MCP client that supports:
114+
115+
- Streamable HTTP transport
116+
- MCP OAuth, or support for setting up headers for the HTTP transport
117+
118+
Get the URL of your MCP Gateway by clicking the "Copy URL" button in the MCP Gateway details page.
119+
120+
<Image
121+
alt={"MCP Gateway URL"}
122+
className="max-w-full dark:hidden"
123+
src={"/images/mcp-gateway/mcp-url-light.png"}
124+
width={MCP_GATEWAY_URL_LIGHT_WIDTH / IMAGE_SCALE_FACTOR}
125+
height={MCP_GATEWAY_URL_LIGHT_HEIGHT / IMAGE_SCALE_FACTOR}
126+
/>
127+
<Image
128+
alt={"MCP Gateway URL"}
129+
className="hidden max-w-full dark:block"
130+
src={"/images/mcp-gateway/mcp-url-dark.png"}
131+
width={MCP_GATEWAY_URL_DARK_WIDTH / IMAGE_SCALE_FACTOR}
132+
height={MCP_GATEWAY_URL_DARK_HEIGHT / IMAGE_SCALE_FACTOR}
133+
/>
134+
135+
<Tabs items={["Cursor", "VS Code"]} storageKey="preferredAgent">
136+
<Tabs.Tab>
137+
138+
1. Open the command palette (Mac: Cmd + Shift + p / Windows: Ctrl + Shift + p) and select **Open MCP Settings**
139+
1. Click on the **New MCP Server** button
140+
141+
Cursor will open the MCP settings file, and you can add a new entry to the `mcpServers` object:
142+
143+
```json
144+
{
145+
"mcpServers": {
146+
"mcp-arcade": {
147+
"url": "https://api.arcade.dev/mcp/<YOUR-GATEWAY-SLUG>",
148+
"headers": {
149+
"Authorization": "Bearer {arcade_api_key}",
150+
"Arcade-User-ID": "{arcade_user_id}"
151+
}
152+
}
153+
}
154+
}
155+
```
156+
157+
</Tabs.Tab>
158+
<Tabs.Tab>
159+
160+
1. Open the command palette and select **MCP: Add Server...**
161+
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. 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+
```
182+
183+
</Tabs.Tab>
184+
</Tabs>
185+
186+
<Callout type="info">
187+
You can get an API key from the dashboard, following these instructions:
188+
[Getting Your API Key](/home/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+
195+
### Try it out
196+
197+
1. Open your IDE's chat pane.
198+
1. Ask the agent to do something! For example, "Check the latest linear issue assigned to me. Then, create a new GitHub branch, implement the fix, and add tests. If all the tests pass, create a pull request and assign it to me."
199+
200+
As you interact with the agent, it will call the tools from the MCP Gateway. Your agent should prompt you to visit links to authorize access to Linear and GitHub. After this, it will start using tools to carry out the task! Subsequent calls will not require authorization.
201+
202+
</Steps>
203+
204+
## Next Steps
205+
206+
- Learn more about [MCP Gateways](/home/mcp-gateways).
207+
- Learn how to use MCP Gateways with:
208+
- [Cursor](/home/mcp-clients/cursor)
209+
- [Visual Studio Code](/home/mcp-clients/visual-studio-code)
210+
- Build your own MCP servers with [arcade-mcp](/home/custom-mcp-server-quickstart).
158 KB
Loading
162 KB
Loading
92.7 KB
Loading
95.3 KB
Loading
424 KB
Loading
463 KB
Loading

0 commit comments

Comments
 (0)