Skip to content

Commit 7ef897f

Browse files
authored
On prem MCP servers (formerly Hybrid MCP servers) (#491)
on prem MCP servers
1 parent 6667d22 commit 7ef897f

File tree

4 files changed

+74
-31
lines changed

4 files changed

+74
-31
lines changed

app/en/home/deployment/_meta.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const meta: MetaRecord = {
99
},
1010
},
1111
"on-prem-mcp": {
12-
title: "On-premise MCP servers",
12+
title: "On-premises MCP servers",
1313
},
1414
"engine-configuration": {
1515
title: "Engine configuration",
Lines changed: 71 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "On-premise MCP Servers"
2+
title: "On-premises MCP Servers"
33
description: "Learn how to deploy MCP servers in a hybrid architecture"
44
---
55

@@ -25,93 +25,134 @@ The on-premises MCP server model uses a bidirectional connection between your lo
2525
- **Custom environments**: Use specific dependencies or configurations required by your tools
2626
- **Compliance**: Meet regulatory requirements by keeping data processing within your infrastructure
2727

28-
## Setting up a hybrid worker
28+
## Setting up an on-premises MCP server
2929

3030
<Steps>
3131

3232
### Setup your MCP Servers
3333

3434
Follow the [Creating a MCP Server](/home/build-tools/create-a-mcp-server) guide to create your MCP Server.
3535

36-
### Start your local worker
36+
### Start your local MCP Server
3737

38-
Run your Arcade worker locally with a secret that you generate in a secure way:
38+
Ensure you are logged in to Arcade:
3939

40-
```sh
41-
export ARCADE_WORKER_SECRET=your-secret
42-
arcade serve
40+
<Tabs items={["CLI", "Environment Variable"]}>
41+
<Tabs.Tab>
42+
43+
```bash
44+
arcade login
45+
```
46+
47+
</Tabs.Tab>
48+
<Tabs.Tab>
49+
50+
Add the environment variables to your shell:
51+
52+
```bash
53+
export ARCADE_API_KEY=<your-api-key>
54+
export ARCADE_USER_ID=<your-user-id>
55+
```
56+
57+
or to a `.env` file:
58+
59+
```env filename=".env"
60+
ARCADE_API_KEY=<your-api-key>
61+
ARCADE_USER_ID=<your-user-id>
62+
```
63+
64+
</Tabs.Tab>
65+
</Tabs>
66+
67+
Run your Arcade MCP Server locally with a secret that you generate in a secure way:
68+
69+
```bash
70+
cd <your-mcp-server-directory>
71+
arcade mcp
4372
```
4473

45-
Verify your worker is running by visiting http://localhost:8002/worker/health.
74+
Your MCP server is running on http://127.0.0.1:8000
4675

4776
### Create a public URL
4877

49-
To allow the Arcade cloud engine to connect to your locally running worker, you need a public URL. Here are a few options:
78+
To allow the Arcade cloud engine to connect to your locally running MCP Server, you need a public URL. Here are a few options:
5079

5180
<Tabs items={["ngrok", "Cloudflare", "Tailscale"]}>
5281
<Tabs.Tab>
5382

54-
```sh
55-
ngrok http 8002
83+
```bash
84+
ngrok http 8000
5685
```
5786

5887
</Tabs.Tab>
5988

6089
<Tabs.Tab>
6190

62-
```sh
63-
cloudflared tunnel --url http://localhost:8002
91+
```bash
92+
cloudflared tunnel --url http://localhost:8000
6493
```
6594

6695
</Tabs.Tab>
6796

6897
<Tabs.Tab>
6998

70-
```sh
71-
tailscale funnel 8002
99+
```bash
100+
tailscale funnel 8000
72101
```
73102

74103
</Tabs.Tab>
75104
</Tabs>
76105

77-
### Register your worker in Arcade
106+
### Register your MCP Server in Arcade
78107

79108
1. Navigate to the [Servers](https://api.arcade.dev/dashboard/servers) page in your Arcade dashboard
80109
1. Click **Add Server**
81110
1. Fill in the form:
82111
- **ID**: Choose a unique identifier (e.g., `my-server`)
83-
- **Worker Type**: Select `Arcade`
84-
- **URL**: Enter your public URL from Step 3
85-
- **Secret**: Enter the secret for your worker (or use `dev` for testing)
112+
- **Server Type**: Select `MCP`
113+
- **URL**: Enter your public URL from Step 3, and add `/mcp` to the end
86114
- **Timeout** and **Retry**: Configure as needed for your use case
87115
1. Click **Create**
88116

89-
### Test the connection to your worker
117+
### Test the connection to your MCP Server
90118

91-
You can now test your worker by making requests through the Arcade API or using the Playground:
119+
You can now test your MCP Server by making requests using the Playground, or an MCP client:
120+
121+
<Tabs items={["Playground", "MCP Client"]}>
122+
<Tabs.Tab>
92123

93124
1. Go to the [Playground](https://api.arcade.dev/dashboard/playground)
94125
1. Select a tool from your MCP Server and execute it
95-
1. Verify that the response is correct and you see request logs in your worker
126+
1. Verify that the response is correct and you see request logs in your MCP Server
127+
128+
</Tabs.Tab>
129+
<Tabs.Tab>
130+
131+
1. Use an app that supports MCP clients, like AI assistants and IDEs:
132+
- [Visual Studio Code](/home/mcp-clients/visual-studio-code)
133+
- [Claude Desktop](/home/mcp-clients/claude-desktop)
134+
- [Cursor](/home/mcp-clients/cursor)
135+
1. Enable your MCP Server from the list of available MCP Servers
136+
1. Verify that the response is correct and you see request logs in your MCP Server
137+
138+
</Tabs.Tab>
139+
</Tabs>
96140

97141
</Steps>
98142

99143
## Best practices
100144

101145
- **Persistent URLs**: For production use, set up a persistent public URL rather than ephemeral ones
102146
- **TLS**: Use a TLS-enabled URL for production use
103-
- **Security**: Use strong secrets for worker authentication
104-
- **Monitoring**: Set up monitoring for your hybrid workers to ensure availability
105-
- **Scaling**: For high-load scenarios, consider running multiple workers behind a load balancer
147+
- **Monitoring**: Set up monitoring for your MCP Server to ensure availability
106148

107149
## Troubleshooting
108150

109-
- **Connection issues**: Ensure your public URL is accessible and that your local worker is running
110-
- **Authentication failures**: Verify that the worker secret matches what's configured in the Arcade dashboard
111-
- **Timeout errors**: If your worker takes too long to respond, increase the timeout value in the worker configuration
151+
- **Connection issues**: Ensure your public URL is accessible and that your local MCP Server is running
152+
- **Timeout errors**: If your MCP Server takes too long to respond, increase the timeout value in the MCP Server configuration
112153

113154
## Next steps
114155

115-
- [Create custom tools](/home/build-tools/create-a-mcp-server) for your hybrid worker
156+
- [Create custom tools](/home/build-tools/create-a-mcp-server) for your MCP Server
116157
- [Set up authentication](/home/build-tools/create-a-tool-with-auth) for secure access to resources
117-
- [Configure secrets](/home/build-tools/create-a-tool-with-secrets) for your worker
158+
- [Configure secrets](/home/build-tools/create-a-tool-with-secrets) for your MCP Server

app/en/home/mcp-clients/_meta.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export default {
22
"claude-desktop": "Claude Desktop",
33
"visual-studio-code": "Visual Studio Code",
4+
cursor: "Cursor",
45
};
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Coming soon...

0 commit comments

Comments
 (0)