Skip to content

Commit d254822

Browse files
committed
Update overview pages
Signed-off-by: Dan Barr <6922515+danbarr@users.noreply.github.com>
1 parent 2205621 commit d254822

6 files changed

Lines changed: 683 additions & 48 deletions

File tree

docs/toolhive/guides-cli/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import DocCardList from '@theme/DocCardList';
1010
## Introduction
1111

1212
The ToolHive CLI (`thv`) is a command-line tool that allows you to deploy and
13-
manage MCP servers on your local machines or in development environments. It
13+
manage MCP servers on your local machine or in development environments. It
1414
provides quick deployment of MCP servers and supports advanced features like
1515
custom permissions, network access filtering, and telemetry.
1616

docs/toolhive/guides-registry/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import DocCardList from '@theme/DocCardList';
99

1010
## Introduction
1111

12-
The ToolHive Registry server implements the official
13-
[Model Context Protocol (MCP) Registry API specification](https://github.com/modelcontextprotocol/registry/blob/main/docs/reference/api/generic-registry-api.md)
12+
The ToolHive Registry Server is an implementation of the official
13+
[Model Context Protocol (MCP) Registry API specification](https://github.com/modelcontextprotocol/registry/blob/main/docs/reference/api/generic-registry-api.md).
1414
It provides a standardized REST API for discovering and accessing MCP servers
1515
from multiple backend sources, including Kubernetes clusters, Git repositories,
1616
API endpoints, and local files.

docs/toolhive/index.mdx

Lines changed: 109 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,43 @@ import ThemedImage from '@theme/ThemedImage';
3737

3838
# What is ToolHive?
3939

40-
ToolHive simplifies the deployment and management of Model Context Protocol
41-
(MCP) servers. It ensures ease of use, consistency, and security by running
42-
containers in a locked-down environment with minimal permissions.
40+
ToolHive is an enterprise-grade open source (Apache 2.0) platform for running
41+
and managing Model Context Protocol (MCP) servers.
4342

4443
Follow the [getting started guide](./tutorials/quickstart-ui.mdx) to install
45-
ToolHive and run your first MCP server.
44+
ToolHive locally and run your first MCP server.
4645

4746
To learn more about the Model Context Protocol, see our
4847
[MCP primer](./concepts/mcp-primer.mdx).
4948

50-
ToolHive is available in three modes to suit different use cases:
49+
## ToolHive components
50+
51+
ToolHive includes everything you need to use MCP servers in production. It's
52+
made up of four key components: the Runtime, Registry Server, Gateway, and
53+
Portal.
54+
55+
<ThemedImage
56+
alt='ToolHive platform architecture overview'
57+
sources={{
58+
light: useBaseUrl('/img/toolhive/toolhive-platform-light.svg'),
59+
dark: useBaseUrl('/img/toolhive/toolhive-platform-dark.svg'),
60+
}}
61+
title='ToolHive platform architecture overview'
62+
width={'800px'}
63+
style={{
64+
paddingBottom: '1rem',
65+
}}
66+
/>
67+
68+
### Runtime
69+
70+
The ToolHive Runtime is the core component that runs MCP servers in isolated
71+
containers. It provides a secure and scalable environment for deploying MCP
72+
servers, with features like fine-grained permissions, network access controls,
73+
and secret management.
74+
75+
The ToolHive Runtime is available in three different editions to suit different
76+
use cases:
5177

5278
- [**ToolHive UI**](./guides-ui/index.mdx): A desktop application for individual
5379
developers to run and manage MCP servers locally. It provides a user-friendly
@@ -56,13 +82,51 @@ ToolHive is available in three modes to suit different use cases:
5682
- [**ToolHive CLI**](./guides-cli/index.mdx): A command line interface to deploy
5783
and manage MCP servers on your local machine or in development environments.
5884
It allows quick deployment of MCP servers and supports advanced features like
59-
custom permissions and telemetry.
85+
telemetry and fine-grained authorization policies.
6086

6187
- [**ToolHive Kubernetes Operator**](./guides-k8s/index.mdx): A Kubernetes
6288
operator for teams and enterprises to run and manage MCP servers in multi-user
6389
environments. It provides centralized management, security controls, and
6490
integration with existing infrastructure.
6591

92+
### Registry Server
93+
94+
The [**ToolHive Registry Server**](./guides-registry/index.mdx) is an
95+
implementation of the official
96+
[MCP Registry API](https://github.com/modelcontextprotocol/registry/blob/main/docs/reference/api/generic-registry-api.md).
97+
Curate a catalog of trusted servers from multiple backend sources for users to
98+
quickly discover and deploy. It can be deployed standalone or as part of the
99+
ToolHive Operator.
100+
101+
### Gateway
102+
103+
Implemented in the ToolHive Kubernetes Operator as the
104+
[**Virtual MCP Server (vMCP)**](./guides-vmcp/index.mdx), the ToolHive Gateway
105+
is a secure proxy for MCP server connectivity, aggregation, and orchestration.
106+
It's available as part of the ToolHive Operator for Kubernetes deployments.
107+
108+
### Portal
109+
110+
The ToolHive Portal is how users discover and install MCP servers. It's
111+
available as a cross-platform desktop app (the ToolHive UI) and an experimental
112+
[web-based frontend](https://github.com/stacklok/toolhive-cloud-ui) to the
113+
ToolHive Registry Server.
114+
115+
### Better together
116+
117+
ToolHive components work together to provide a seamless experience for both
118+
admins and users:
119+
120+
1. **Admins** curate and organize MCP servers in the **Registry**, configuring
121+
access and policies.
122+
2. **Users** discover and request MCP servers from the **Portal**, and ToolHive
123+
orchestrates installation and access.
124+
3. **Runtime** securely deploys and manages MCP servers across local and cloud
125+
environments, integrating seamlessly with existing SDLC workflows, exporting
126+
analytics, and enforcing fine-grained access control.
127+
4. **Gateway** handles all inbound traffic, secures context and credentials,
128+
optimizes tool selection, and applies organizational policies.
129+
66130
## Why ToolHive?
67131

68132
We want to help you get real value from MCP servers. While there are plenty of
@@ -80,50 +144,45 @@ containerize the MCP server and let you use a simple CLI or Kubernetes to manage
80144
MCP deployments at any scale. Coordinate all your MCP servers from one place
81145
with sensible security controls and container-native simplicity.
82146

83-
## Architecture overview
147+
## Key features
84148

85-
ToolHive exposes an HTTP proxy to forward requests to MCP servers running in
86-
containers. The proxy communicates with MCP servers via standard input/output
87-
(stdio), server-sent events (SSE), or Streamable HTTP. The ToolHive CLI
88-
interacts with Docker or Podman via the Docker socket API, letting it manage
89-
containers and their configurations.
149+
ToolHive includes a range of capabilities to help you run and manage MCP servers
150+
effectively:
90151

91-
<ThemedImage
92-
alt='ToolHive architecture overview'
93-
sources={{
94-
light: useBaseUrl('/img/toolhive/toolhive-diagram-light.svg'),
95-
dark: useBaseUrl('/img/toolhive/toolhive-diagram-dark.svg'),
96-
}}
97-
title='ToolHive architecture overview'
98-
/>
99-
<br />
152+
**Runtime:**
100153

101-
## Key features
154+
- Run local MCP servers instantly from the built-in registry of vetted MCP
155+
servers, any Docker container, or directly from package managers
156+
- Deploy MCP servers in the cloud via Kubernetes for enterprise scalability
157+
- Proxy remote MCP servers securely for unified management
158+
- Apply fine-grained permissions and network access filtering
159+
- Protect sensitive data with built-in secrets management and enterprise OAuth
160+
integrations
161+
- Leverage OpenTelemetry and Prometheus for observability and audit logging
102162

103-
ToolHive includes a range of features to help you run and manage MCP servers
104-
effectively:
163+
**Registry Server:**
105164

106-
- **Streamlined deployment**: Deploy MCP servers instantly using Docker
107-
containers or directly from package managers via protocol schemes (`uvx://`,
108-
`npx://`, `go://`). Access a curated registry of verified MCP servers that you
109-
can discover and run effortlessly.
165+
- Curate a catalog of trusted MCP servers from multiple sources: the official
166+
MCP Registry, other public registries, and custom files
167+
- Group servers based on role or use case
168+
- Manage your registry with an API-driven interface
169+
- Preset configurations and permissions for a frictionless user experience
110170

111-
- **Seamless integration**: Configure popular development tools automatically,
112-
including GitHub Copilot and Cursor, to streamline your workflow with minimal
113-
setup.
171+
**Gateway:**
114172

115-
- **Comprehensive security**: Run MCP servers in isolated containers with
116-
customizable, fine-grained permissions and network access filtering using JSON
117-
profiles. Securely manage secrets and configurations using built-in encrypted
118-
storage or 1Password integration, eliminating plaintext secrets in
119-
configuration files.
173+
- Orchestrate multiple tools with a deterministic workflow engine
174+
- Centralize control of security policy, authentication, authorization,
175+
auditing, etc.
176+
- Customize and filter tools and descriptions to improve performance and reduce
177+
token usage
120178

121-
- **Enterprise readiness**: Implement robust OAuth-based authorization controls
122-
for enterprise environments that integrate seamlessly with existing
123-
infrastructure.
179+
**Portal:**
124180

125-
- **Kubernetes deployment**: Deploy and manage MCP servers in Kubernetes
126-
clusters using the ToolHive operator.
181+
- Cross-platform [desktop app](https://github.com/stacklok/toolhive-studio) and
182+
browser-based [cloud UI](https://github.com/stacklok/toolhive-cloud-ui)
183+
- Make it easy for end users to discover and deploy MCP servers
184+
- Install MCP servers with a single click
185+
- Connect with local clients like Claude Desktop, Cursor, VS Code, and many more
127186

128187
## Additional resources
129188

@@ -132,9 +191,15 @@ with other ToolHive users, ask questions, and share your experiences.
132191

133192
Source code and issue tracking:
134193

135-
- ToolHive UI
136-
- [GitHub repository](https://github.com/stacklok/toolhive-studio)
137-
- [Issue tracker](https://github.com/stacklok/toolhive-studio/issues)
138194
- ToolHive CLI & K8s Operator
139195
- [GitHub repository](https://github.com/stacklok/toolhive)
140196
- [Issue tracker](https://github.com/stacklok/toolhive/issues)
197+
- ToolHive UI
198+
- [GitHub repository](https://github.com/stacklok/toolhive-studio)
199+
- [Issue tracker](https://github.com/stacklok/toolhive-studio/issues)
200+
- ToolHive Registry Server
201+
- [GitHub repository](https://github.com/stacklok/toolhive-registry-server)
202+
- [Issue tracker](https://github.com/stacklok/toolhive-registry-server/issues)
203+
- ToolHive Cloud UI (experimental)
204+
- [GitHub repository](https://github.com/stacklok/toolhive-cloud-ui)
205+
- [Issue tracker](https://github.com/stacklok/toolhive-cloud-ui/issues)

src/pages/index.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ export default function Home(): ReactNode {
6161
maxWidth: '40%',
6262
}}
6363
/>
64-
{/* TODO: update description */}
6564
ToolHive simplifies the deployment and management of Model Context
6665
Protocol (MCP) servers, ensuring ease of use, consistency, and
6766
security. It&apos;s available as a standalone tool or as a

0 commit comments

Comments
 (0)