Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 54 additions & 3 deletions docs/toolhive/guides-ui/run-mcp-servers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,20 @@ remaining required information and adjust any optional settings as needed:
external networks. See the [Network isolation](./network-isolation.mdx) guide
for details.

1. **Proxy mode** [Conditional]:\
The proxy transport mode that clients should use to connect to this server.
Choose **SSE** (`sse`) or **Streamable HTTP** (`streamable-http`).
**Streamable HTTP** is the default. This option appears only when the
**transport protocol** is `stdio` and the server is not configured for bearer
token authentication. For `sse` and `streamable-http` transports, the MCP
server already speaks HTTP, so no proxy mode selection is needed.

1. **Proxy port** [Optional]:\
Port for the HTTP proxy to listen on. If not specified, ToolHive
automatically assigns a random port. This is the port that AI clients connect
to, which is distinct from the **target port** that the MCP server itself
listens on inside the container.

:::note

Refer to the MCP server's documentation for the required configuration
Expand Down Expand Up @@ -200,6 +214,12 @@ remaining required information and adjust any optional settings as needed:
name and either select an existing secret or enter a new value to create
one.

1. **Proxy port** [Optional]:\
Port for the HTTP proxy to listen on. If not specified, ToolHive
automatically assigns a random port. **Proxy mode** is not shown for remote
MCP servers because remote transports are always HTTP-based (SSE or
Streamable HTTP).

Click **Install server** to connect to the remote MCP server.

<details id="remote-mcp-examples">
Expand Down Expand Up @@ -283,6 +303,19 @@ On the configuration form, enter:
ToolHive will use a random port that is exposed to the container with the
`MCP_PORT` and `FASTMCP_PORT` environment variables.

1. **Proxy mode** [Conditional]:\
The proxy transport mode that clients should use to connect to this server.
Choose **SSE** (`sse`) or **Streamable HTTP** (`streamable-http`).
**Streamable HTTP** is the default. This option appears only when the
**transport protocol** is `stdio` and the server is not configured for bearer
token authentication.

1. **Proxy port** [Optional]:\
Port for the HTTP proxy to listen on. If not specified, ToolHive
automatically assigns a random port. This is the port that AI clients connect
to, which is distinct from the **target port** that the MCP server itself
listens on inside the container.

1. The Docker **image name** and tag (e.g., `my-mcp-server:latest`). [Required]\
You can use any valid Docker image, including those hosted on Docker Hub or
other registries.
Expand Down Expand Up @@ -344,6 +377,19 @@ On the configuration form, enter:
ToolHive will use a random port that is exposed to the container with the
`MCP_PORT` and `FASTMCP_PORT` environment variables.

1. **Proxy mode** [Conditional]:\
The proxy transport mode that clients should use to connect to this server.
Choose **SSE** (`sse`) or **Streamable HTTP** (`streamable-http`).
**Streamable HTTP** is the default. This option appears only when the
**transport protocol** is `stdio` and the server is not configured for bearer
token authentication.

1. **Proxy port** [Optional]:\
Port for the HTTP proxy to listen on. If not specified, ToolHive
automatically assigns a random port. This is the port that AI clients connect
to, which is distinct from the **target port** that the MCP server itself
listens on inside the container.

1. The package **protocol** (`npx`, `uvx`, or `go`). [Required]

1. The **name** of the package to run. [Required]
Expand Down Expand Up @@ -405,7 +451,12 @@ On the configuration form, enter:
ToolHive supports server-sent events (SSE) and Streamable HTTP (default) for
real-time communication. The protocol must match what the MCP server
supports.
5. **Authorization method**: Choose how ToolHive should authenticate with the
5. **Proxy port** [Optional]:\
Port for the HTTP proxy to listen on. If not specified, ToolHive
automatically assigns a random port. **Proxy mode** is not shown for remote
MCP servers because remote transports are always HTTP-based (SSE or
Streamable HTTP).
6. **Authorization method**: Choose how ToolHive should authenticate with the
remote server.\
The default is **Auto-Discovered**. Use this option for MCP servers that
fully implement the MCP authorization spec including dynamic client
Expand Down Expand Up @@ -459,9 +510,9 @@ On the configuration form, enter:
- **PKCE**: Enable Proof Key for Code Exchange (RFC 7636) for enhanced
security without requiring a client secret. [Optional]

6. The **callback port** for the authentication redirect. [Optional]
7. The **callback port** for the authentication redirect. [Optional]

7. **Custom headers** [Optional]:\
8. **Custom headers** [Optional]:\
Add custom HTTP headers to inject into requests to the remote MCP server.
- **Plaintext headers**: Add static key-value pairs for headers like
`X-Tenant-ID` or correlation IDs. These values are stored and transmitted
Expand Down