Skip to content

Commit 58d5e04

Browse files
danbarrclaude
andcommitted
Fix editorial issues across index and intro pages
Standardize capitalization of "ToolHive Kubernetes Operator" and "ToolHive Registry Server" as product names throughout the docs. Consolidate intro page titles from "Overview" to "Introduction" and rename redundant "Overview" H2s. Shorten duplicate registry disambiguation admonition on index page. Fix import placement, first-person voice, and other minor issues. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 6ddd6b3 commit 58d5e04

10 files changed

Lines changed: 24 additions & 24 deletions

File tree

docs/toolhive/guides-cli/api-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The API server isn't intended for production use. It's designed for local
1313
automation and UI development, and doesn't implement any authentication or
1414
authorization mechanisms.
1515

16-
For production use cases, consider using the ToolHive Kubernetes operator, which
16+
For production use cases, consider using the ToolHive Kubernetes Operator, which
1717
provides a more robust and secure way to manage ToolHive instances in a
1818
multi-user environment.
1919

docs/toolhive/guides-k8s/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Using the ToolHive Kubernetes Operator
33
description:
4-
How-to guides for using the ToolHive Kubernetes operator to run and manage MCP
4+
How-to guides for using the ToolHive Kubernetes Operator to run and manage MCP
55
servers.
66
---
77

docs/toolhive/guides-k8s/intro.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
---
2-
title: Overview
3-
description: How to manage MCP servers in Kubernetes with the ToolHive operator
2+
title: Introduction
3+
description:
4+
How to manage MCP servers in Kubernetes with the ToolHive Kubernetes Operator
45
---
56

6-
The ToolHive Kubernetes operator manages MCP servers in Kubernetes clusters. It
7+
The ToolHive Kubernetes Operator manages MCP servers in Kubernetes clusters. It
78
lets you define MCP servers as Kubernetes resources and automates their
89
deployment and management.
910

1011
:::info
1112

1213
See the [ToolHive Operator quickstart tutorial](./quickstart.mdx) to get started
13-
quickly using a local kind cluster. We'd love for you to try it out and send
14-
feedback!
14+
quickly using a local kind cluster. Try it out and
15+
[share your feedback](https://discord.gg/stacklok)!
1516

1617
:::
1718

18-
## Overview
19+
## How the operator works
1920

2021
The operator introduces new Custom Resource Definitions (CRDs) into your
2122
Kubernetes cluster. The primary CRDs for MCP server workloads are `MCPServer`,

docs/toolhive/guides-k8s/quickstart.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: 'Quickstart: ToolHive Kubernetes Operator'
33
sidebar_label: Quickstart
44
description:
5-
Learn how to deploy the ToolHive Kubernetes operator and use it to manage MCP
5+
Learn how to deploy the ToolHive Kubernetes Operator and use it to manage MCP
66
servers in a Kubernetes cluster.
77
---
88

99
import useBaseUrl from '@docusaurus/useBaseUrl';
1010
import ThemedImage from '@theme/ThemedImage';
1111

12-
In this tutorial, you'll learn how to deploy the ToolHive Kubernetes operator
12+
In this tutorial, you'll learn how to deploy the ToolHive Kubernetes Operator
1313
and use it to manage MCP servers in a Kubernetes cluster. By the end, you'll
1414
have a working operator deployment that automatically manages MCP servers using
1515
Kubernetes resources.

docs/toolhive/guides-mcp/notion-remote.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ thv restart notion-remote
8484

8585
:::note
8686

87-
The ToolHive Kubernetes operator does not currently support remote MCP servers
87+
The ToolHive Kubernetes Operator does not currently support remote MCP servers
8888
using dynamic OAuth authentication. Instead, you can run the
8989
[local Notion MCP server](https://github.com/makenotion/notion-mcp-server) in
9090
Kubernetes using a static integration key.

docs/toolhive/guides-registry/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ 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.
1717

18-
:::note[Registry Server vs. built-in registry]
18+
:::note
1919

20-
This is the **Registry Server**a standalone service for hosting and curating
21-
your own MCP server catalog. For the built-in registry that ships with ToolHive,
22-
see [Explore the registry](../guides-cli/registry.mdx) (CLI) or
20+
This section covers the **Registry Server**, a standalone service you deploy
21+
yourself. Looking for the built-in registry instead? See
22+
[Explore the registry](../guides-cli/registry.mdx) (CLI) or
2323
[Explore the registry](../guides-ui/registry.mdx) (UI).
2424

2525
:::

docs/toolhive/guides-registry/intro.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
2-
title: Overview
3-
sidebar_label: Introduction
2+
title: Introduction
43
description:
5-
How to use the ToolHive Registry server to discover and access MCP servers and
4+
How to use the ToolHive Registry Server to discover and access MCP servers and
65
skills
76
---
87

9-
The ToolHive Registry server is a standards-compliant implementation of the MCP
8+
The ToolHive Registry Server is a standards-compliant implementation of the MCP
109
Registry API specification. It provides a REST API for discovering and accessing
1110
MCP servers from multiple backend sources.
1211

@@ -22,7 +21,7 @@ MCP servers from the default catalog. That's a different feature: see
2221

2322
:::
2423

25-
## Overview
24+
## How the Registry Server works
2625

2726
The Registry server aggregates MCP server metadata from various sources and
2827
exposes it through a standardized API. When you start the server, it:

docs/toolhive/guides-vmcp/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Virtual MCP Server
33
description: Aggregate multiple MCP servers into a single unified endpoint.
44
---
55

6+
import DocCardList from '@theme/DocCardList';
7+
68
## Introduction
79

810
Virtual MCP Server (vMCP) is ToolHive's MCP gateway. It aggregates multiple
@@ -22,6 +24,4 @@ connection.
2224

2325
## Contents
2426

25-
import DocCardList from '@theme/DocCardList';
26-
2727
<DocCardList />

docs/toolhive/guides-vmcp/intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Introduction to vMCP
33
description: Understand what Virtual MCP Server (vMCP) does and when to use it.
44
---
55

6-
## Overview
6+
## What is vMCP?
77

88
Virtual MCP Server (vMCP) is a feature of the ToolHive Kubernetes Operator that
99
acts as an aggregation proxy, consolidating multiple backend MCP servers into a

docs/toolhive/integrations/opentelemetry.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ running in Docker containers. This approach is perfect for:
5252

5353
**ToolHive Kubernetes Operator + in-cluster observability**
5454

55-
Use the ToolHive Kubernetes operator to manage MCP servers in a cluster, with
55+
Use the ToolHive Kubernetes Operator to manage MCP servers in a cluster, with
5656
Jaeger and Prometheus deployed inside Kubernetes. This approach is ideal for:
5757

5858
- Production-like environments

0 commit comments

Comments
 (0)