Skip to content

Commit 8d61ed1

Browse files
committed
ui: add remote mcp section
1 parent 5630f05 commit 8d61ed1

File tree

1 file changed

+54
-7
lines changed

1 file changed

+54
-7
lines changed

docs/toolhive/guides-ui/run-mcp-servers.md

Lines changed: 54 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,64 @@ states.
103103

104104
## Install a custom MCP server
105105

106-
You're not limited to the MCP servers in the registry. You can also run your own
107-
custom MCP servers using Docker images or source packages.
106+
You're not limited to the MCP servers in the registry. You can run remote MCP
107+
providing a url or your own local custom MCP servers using Docker images or
108+
source packages.
108109

109-
On the **MCP Servers** page, click **Add server**, then choose **Custom MCP
110-
server** in the drop-down menu. Or if this is your first MCP server, click **Add
111-
custom server** on the introductory screen.
110+
### Remote MCP server
111+
112+
On the **MCP Servers** page, click **Add an MCP server**, then choose **Add a
113+
remote MCP server** in the drop-down menu. Or if this is your first MCP server,
114+
on the introductory screen.
115+
116+
On the configuration form, enter:
117+
118+
1. A unique **name** for the MCP server. [Required]
119+
120+
2. the server **url** of the MCP server. [Required]
121+
122+
3. The **transport protocol** that the MCP server uses. [Required] ToolHive
123+
supports server-sent events (SSE), and Streamable HTTP (default value) for
124+
real-time communication. The protocol must match what the MCP server
125+
supports.
126+
127+
4. The authorization method (default **None** simple transparent forwarding).
128+
ToolHive supports OAuth2/OIDC, and dynamic client registration.
129+
130+
Selecting **OAuth2** authentication method:
131+
- the **authorize URL** where users are redirected to authenticate and
132+
authorize your MCP. [Required]
133+
- the **token url** where your application exchanges the authorization code
134+
for access tokens. [Required]
135+
- the **client id** for your application registered with the OAuth provider.
136+
[Required]
137+
- the **client secret** key that proves your application's identity.
138+
[Required]
139+
- the **scopes** list of permissions your app is requesting
140+
141+
Selecting **OIDC** authentication method:
142+
- the base **issuer URL** of the OIDC provider. [Required]
143+
- the **client id** for your application registered with the OIDC provider.
144+
[Required]
145+
- the **client secret** key that proves your application's identity.
146+
[Required]
147+
- the **PKCE** Proof Key for Code Exchange (RFC 7636), automatically enables
148+
PKCE flow without client_secret
149+
150+
5. the **callback port** for the authentication redirect.
151+
152+
Click **Install server** to run the MCP server.
153+
154+
### Local custom MCP server
155+
156+
On the **MCP Servers** page, click **Add an MCP server**, then choose **Add
157+
custom local server** in the drop-down menu. Or if this is your first MCP
158+
server, on the introductory screen.
112159

113160
In the **Custom MCP server** dialog, choose [Docker image](#from-a-docker-image)
114161
or [Package manager](#from-a-source-package).
115162

116-
### From a Docker image
163+
#### From a Docker image
117164

118165
Select the **Docker image** option. This allows you to run any MCP server that
119166
is available as a Docker image in a remote registry or locally on your system.
@@ -154,7 +201,7 @@ On the configuration form, enter:
154201

155202
Click **Install server** to create and start the MCP server container.
156203

157-
### From a source package
204+
#### From a source package
158205

159206
Select the **Package manager** option. This allows you to run an MCP server from
160207
a source package.

0 commit comments

Comments
 (0)