diff --git a/app/en/guides/mcp-gateways/_meta.tsx b/app/en/guides/mcp-gateways/_meta.tsx index be0f96723..2183b7884 100644 --- a/app/en/guides/mcp-gateways/_meta.tsx +++ b/app/en/guides/mcp-gateways/_meta.tsx @@ -1,6 +1,9 @@ import type { MetaRecord } from "nextra"; export const meta: MetaRecord = { + "add-remote-servers": { + title: "Add remote MCP servers", + }, "create-via-dashboard": { title: "Create via Dashboard", }, diff --git a/app/en/guides/mcp-gateways/add-remote-servers/page.mdx b/app/en/guides/mcp-gateways/add-remote-servers/page.mdx new file mode 100644 index 000000000..12e28b8a6 --- /dev/null +++ b/app/en/guides/mcp-gateways/add-remote-servers/page.mdx @@ -0,0 +1,156 @@ +--- +title: "Add remote MCP servers" +description: "Register a remote MCP server in Arcade and use its tools in gateways and SDKs" +--- + +import Image from "next/image"; +import { Callout, Steps, Tabs } from "nextra/components"; +import { SignupLink } from "@/app/_components/analytics"; + +export const REMOTE_SETUP_WIDTH = 557 / 1.5; +export const REMOTE_SETUP_HEIGHT = 773 / 1.5; + +# Add remote MCP servers + +Use this guide if you want to connect an existing MCP server that Arcade does not host. You will add the server to your Arcade project, expose its tools in MCP Gateways, and call those tools from Arcade SDKs. + + + + +Register a remote MCP server and use its tools in gateways and SDKs. + + + + + +- An Arcade account +- A remote MCP server URL that Arcade can reach +- Access to any auth credentials your server requires + + + + + +- Add a remote MCP server to an Arcade project +- Configure advanced connection settings +- Use the server tools in MCP Gateways and SDKs + + + + +## Why use MCP Gateways for Remote MCP Servers + +MCP Gateways let you manage and filter tools in one place, so your agent or team uses a curated set of tools across clients. This is especially useful for remote MCP servers, where you may not have control over the tools available. By using MCP Gateways, you can select the tools you want to use and hide the ones you don't want to use. + +## Add the remote server to your project + + + +### Open the MCP servers page + +Go to the [MCP servers dashboard](https://api.arcade.dev/dashboard/servers) for your project and click **Add server**. + +### Enter the required fields + +Arcade requires two fields for remote MCP servers: + +- **ID**: A unique, human-readable identifier (for example, `render-mcp-server`) +- **URI**: The public URL for your MCP server (for example, `https://mcp.render.com/mcp`) + + + Use the [MCP Debugger](https://mcpdebugger.dev) to verify the remote server's + MCP compliance before adding it to Arcade. + + +{"Remote + +### Save and confirm the connection + +Create the server and confirm that Arcade lists the server tools in your project. If the remote MCP server requires authentication, Arcade will prompt you to complete the OAuth flow. + +Arcade pre-loads the list of tools available to the user who configures the remote MCP server so that you can filter them by your own criteria in your MCP Gateways. Be sure to connect as an 'admin' user who has access to the broadest selection of tools in the remote server. Arcade then re-load the list of tools for every user using your agent - if a tool is not available to the agent's end-user, it will not be available via the gateway. + + + +## Configure advanced settings + +Remote MCP servers often require more than a URL. Use **Advanced settings** to configure connection, OAuth, and header details. + +Common settings include: + +- **Connection settings**: Configure timeout and retry values for tool calls. +- **OAuth2 authorization (optional)**: Add client ID and client secret, and set an authorization URL if it differs from the MCP server URI. Use the provided redirect URI when configuring your OAuth app. +- **Custom headers**: Add headers such as `Authorization` or `X-API-Key` and reference secrets with `${secret:NAME}`. +- **Header secrets**: Store API tokens or passwords and reference them in headers. + +## Use remote tools in MCP Gateways + +Once the server is registered, its tools show up in the Playground for this project, as well as in the MCP Gateway tool picker. + +1. Create or edit an MCP Gateway in the [MCP Gateways dashboard](https://app.arcade.dev/mcp-gateways). +2. Open **Select tools** and filter by your remote server name. +3. Choose the tools you want to expose through the gateway. + +## Call remote tools from Arcade SDKs + +Remote tools behave like any other Arcade tool. Try it out in the Playground first to learn any nuances about the name and arguments. Copy the tool name from the tool picker or tool catalog, then call it with the SDK. + + + + +```python +from arcade import Arcade + +client = Arcade(api_key="ARCADE_API_KEY") + +result = client.tools.execute( + tool_name="render-mcp-server.get_key_value", + input={"keyValueId": "foo-bar"}, + user_id="user-123", +) + +print(result) +``` + + + + +```typescript +import { Arcade } from "@arcadeai/arcade"; + +const client = new Arcade({ apiKey: "ARCADE_API_KEY" }); + +const result = await client.tools.execute({ + tool_name: "render-mcp-server.get_key_value", + input: { keyValueId: "foo-bar" }, + user_id: "user-123", +}); + +console.log(result); +``` + + + + +## Limitations and caveats + + + Remote servers must be reachable from Arcade and must support the Streamable + HTTP(s) transport. If your server depends on non-HTTP MCP transports, Arcade + cannot proxy it. + + +- If the remote server is offline, gateway and SDK calls will fail until it is reachable again. +- MCP Gateways only expose the tools you select, not every tool on the server. +- Arcade only supports tools from remote MCP servers today. Prompts, resources, and sampling are not supported yet. + +## Next steps + +- [Create an MCP Gateway](/guides/mcp-gateways/create-via-dashboard) +- [Connect to MCP clients](/get-started/mcp-clients) diff --git a/app/en/guides/mcp-gateways/page.mdx b/app/en/guides/mcp-gateways/page.mdx index 56fd3106e..39ad8408f 100644 --- a/app/en/guides/mcp-gateways/page.mdx +++ b/app/en/guides/mcp-gateways/page.mdx @@ -38,6 +38,17 @@ that you built yourself, or were not built by Arcade. AI Assistant - Describe what you want in natural language and let AI select the right tools for you. Best for quickly creating a gateway without ever leaving your chat interface. +## Add remote MCP servers + +Use remote MCP servers when your tools live outside Arcade. Register the server once, then select its tools in your gateways. + + + + + ## Connect to an MCP Gateway Any MCP client that supports the Streamable HTTP transport can use an Arcade MCP Gateway. Use your gateway URL in the following format: diff --git a/public/images/mcp-gateway/remote-mcp-server-advanced-settings.png b/public/images/mcp-gateway/remote-mcp-server-advanced-settings.png new file mode 100644 index 000000000..c65f8aa2c Binary files /dev/null and b/public/images/mcp-gateway/remote-mcp-server-advanced-settings.png differ diff --git a/public/images/mcp-gateway/remote-mcp-server-setup.png b/public/images/mcp-gateway/remote-mcp-server-setup.png new file mode 100644 index 000000000..dbeeb89fd Binary files /dev/null and b/public/images/mcp-gateway/remote-mcp-server-setup.png differ diff --git a/public/llms.txt b/public/llms.txt index 405cd03ae..bdf1df91a 100644 --- a/public/llms.txt +++ b/public/llms.txt @@ -1,4 +1,4 @@ - + # Arcade @@ -62,6 +62,7 @@ Arcade delivers three core capabilities: Deploy agents even your security team w ## Documentation - [About Arcade](https://docs.arcade.dev/en/get-started/about-arcade.md): This documentation page explains how Arcade facilitates agent authorization for applications that require access to sensitive user data and services. It details the OAuth 2.0 authorization system that enables AI agents to securely act on behalf of users, perform tasks like sending emails or creating +- [Add remote MCP servers](https://docs.arcade.dev/en/guides/mcp-gateways/add-remote-servers.md): This documentation page guides users on how to register and configure remote MCP servers within the Arcade platform, enabling the use of their tools in MCP Gateways and SDKs. It outlines the prerequisites, step-by-step setup process, and advanced configuration options necessary for - [Add user authorization to your MCP tools](https://docs.arcade.dev/en/guides/create-tools/tool-basics/create-tool-auth.md): This documentation page guides users on how to implement user authorization in their custom MCP tools using Arcade, OAuth, and various authentication providers, such as Reddit. It covers the necessary prerequisites, the functioning of auth providers, and step-by-step instructions for creating an - [Adding Resource Server Auth to Your MCP Server](https://docs.arcade.dev/en/guides/security/secure-your-mcp-server.md): This documentation page provides guidance on securing your HTTP MCP server using OAuth 2.1 Resource Server authentication, ensuring that only authorized users can access your tools. It outlines the necessary prerequisites, explains the importance of Resource Server auth, and details how to configure - [Agentic Development](https://docs.arcade.dev/en/get-started/setup/connect-arcade-docs.md): This documentation page provides guidance on utilizing Agentic Development to enhance coding efficiency in AI-integrated IDEs by leveraging Arcade.dev's resources. It explains how to configure the LLMs.txt file for easy access to documentation and introduces Context7, a server