Skip to content

Commit 9947681

Browse files
Update ToolHive reference docs for v0.1.1 (#31)
* Update ToolHive reference docs for v0.1.1 * Update registry output examples --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Dan Barr <[email protected]>
1 parent 17bf5d1 commit 9947681

File tree

4 files changed

+43
-31
lines changed

4 files changed

+43
-31
lines changed

docs/toolhive/guides-cli/registry.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,24 @@ To list all MCP servers in the ToolHive registry, run:
1616
thv registry list
1717
```
1818

19-
This command displays a list of servers with their name, description, transport
20-
method, and the number of stars and downloads to help you identify the most
21-
popular and useful servers.
19+
This command displays a list of servers with their name, description, tier
20+
(official or community), and the number of stars and downloads to help you
21+
identify the most popular and useful servers.
2222

2323
Example output:
2424

2525
```text
26-
NAME DESCRIPTION TRANSPORT STARS PULLS
27-
atlassian Model Context Protocol (MCP) server for Atlassian product... stdio 1557 3719
28-
aws-kb-retrieval-server MCP server for retrieving information from the AWS Knowle... stdio 47366 2251
29-
brave-search MCP server that integrates the Brave Search API, providin... stdio 47366 6022
30-
everart Image generation server for Claude Desktop using EverArt'... stdio 47366 3937
31-
everything This MCP server attempts to exercise all the features of ... stdio 47366 5150
32-
fetch A Model Context Protocol server that provides web content... stdio 47366 6414
33-
filesystem Node.js server implementing Model Context Protocol (MCP) ... stdio 47366 8750
34-
firecrawl A powerful web scraping and content extraction MCP server... stdio 3141 3597
35-
gdrive This MCP server integrates with Google Drive to allow lis... stdio 47366 3650
36-
git A Model Context Protocol server for Git repository intera... stdio 47366 4262
37-
github The GitHub MCP Server provides seamless integration with ... stdio 13894 5000
26+
NAME DESCRIPTION TIER STARS PULLS
27+
atlassian Model Context Protocol (MCP) server for Atlassian product... Community 2194 7789
28+
elasticsearch Connect to your Elasticsearch data directly from any MCP ... Official 305 5429
29+
everything This MCP server attempts to exercise all the features of ... Community 56714 10441
30+
fetch A Model Context Protocol server that provides web content... Community 56714 9078
31+
filesystem Node.js server implementing Model Context Protocol (MCP) ... Community 56714 14041
32+
firecrawl A powerful web scraping and content extraction MCP server... Official 3605 7630
33+
git A Model Context Protocol server for Git repository intera... Community 56714 7000
34+
github The GitHub MCP Server provides seamless integration with ... Official 16578 5000
35+
grafana A Model Context Protocol (MCP) server for Grafana that pr... Official 1014 4900
36+
k8s MKP is a Model Context Protocol (MCP) server for Kubernet... Community 32 8064
3837
3938
<... trimmed for brevity ...>
4039
```
@@ -78,12 +77,15 @@ thv registry info <server-name> --format json
7877

7978
### Example output
8079

81-
```yaml {1,8,16,21} showLineNumbers
80+
```yaml {1,11,19,24} showLineNumbers
8281
Name: github
8382
Image: ghcr.io/github/github-mcp-server:latest
8483
Description: The GitHub MCP Server provides seamless integration with GitHub APIs, enabling advanced automation and interaction capabilities for developers and tools
84+
Tier: Official
85+
Status: Active
8586
Transport: stdio
8687
Repository URL: https://github.com/github/github-mcp-server
88+
Has Provenance: Yes
8789
Popularity: 13894 stars, 5000 pulls
8890
Last Updated: 2025-05-20T00:21:46Z
8991
Tools:
@@ -113,13 +115,13 @@ and security profile before running it.
113115
114116
- **Server name** (line 1): The server name to use with the
115117
[`thv run`](../reference/cli/thv_run.md) command
116-
- **Metadata** (lines 2-7): Details about the server, including the image name,
117-
description, transport method, repository URL, popularity, and last updated
118-
date
119-
- **Tools list** (line 8): The list of tools this MCP server provides
120-
- **Configuration** (line 16): Required and optional environment variables
118+
- **Metadata** (lines 2-10): Details about the server, including the image name,
119+
description, status, transport method, repository URL, whether the server has
120+
SLSA provenance available for verification, and popularity
121+
- **Tools list** (line 11): The list of tools this MCP server provides
122+
- **Configuration** (line 19): Required and optional environment variables
121123
needed to run the server
122-
- **Permissions** (line 21): The permission profile applied to the server,
124+
- **Permissions** (line 24): The permission profile applied to the server,
123125
including file system and network access (see
124126
[Custom permissions](./custom-permissions.mdx))
125127

docs/toolhive/reference/cli/thv_config_set-registry-url.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ thv config set-registry-url <url> [flags]
1717
### Options
1818

1919
```
20-
-h, --help help for set-registry-url
20+
-p, --allow-private-ip Allow setting the registry URL, even if it references a private IP address
21+
-h, --help help for set-registry-url
2122
```
2223

2324
### Options inherited from parent commands

docs/toolhive/tutorials/quickstart.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,10 +142,11 @@ thv registry list
142142
You'll see output similar to this:
143143

144144
```text
145-
NAME DESCRIPTION TRANSPORT STARS PULLS
146-
fetch A Model Context Protocol server that provides web content... stdio 49668 7062
147-
github The GitHub MCP Server provides seamless integration with ... stdio 14545 5000
148-
postgres A Model Context Protocol server that provides read-only a... stdio 49668 9095
145+
NAME DESCRIPTION TIER STARS PULLS
146+
atlassian Model Context Protocol (MCP) server for Atlassian product... Community 2194 7789
147+
fetch A Model Context Protocol server that provides web content... Community 56714 9078
148+
github The GitHub MCP Server provides seamless integration with ... Official 16578 5000
149+
notion Official Notion MCP server. Official 2358 1109
149150
...
150151
```
151152

@@ -212,8 +213,8 @@ thv list
212213
You should see output similar to this:
213214

214215
```text
215-
CONTAINER ID NAME IMAGE STATE TRANSPORT PORT URL
216-
f01ed0263286 fetch mcp/fetch:latest running stdio 49226 http://localhost:49226/sse#fetch
216+
NAME PACKAGE STATUS URL PORT TOOL TYPE CREATED AT
217+
fetch mcp/fetch:latest running http://127.0.0.1:15266/sse#fetch 15266 mcp 2025-06-30 09:12:53 -0400 EDT
217218
```
218219

219220
This confirms that the fetch server is running and available on port 49226.

static/api-specs/toolhive-api.yaml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,10 @@ components:
168168
description: RepositoryURL is the URL to the source code repository for
169169
the server
170170
type: string
171+
status:
172+
description: The Status indicates whether the server is currently active
173+
or deprecated
174+
type: string
171175
tags:
172176
description: Tags are categorization labels for the server to aid in discovery
173177
and filtering
@@ -177,8 +181,12 @@ components:
177181
uniqueItems: false
178182
target_port:
179183
description: TargetPort is the port for the container to expose (only applicable
180-
to SSE transport)
184+
to SSE and Streamable HTTP transports)
181185
type: integer
186+
tier:
187+
description: Tier represents the tier classification level of the server,
188+
e.g., "official" or "community" driven
189+
type: string
182190
tools:
183191
description: Tools is a list of tool names provided by this MCP server
184192
items:
@@ -187,7 +195,7 @@ components:
187195
uniqueItems: false
188196
transport:
189197
description: Transport defines the communication protocol for the server
190-
(stdio or sse)
198+
(stdio, sse, or streamable-http)
191199
type: string
192200
type: object
193201
registry.Metadata:

0 commit comments

Comments
 (0)