Skip to content

Update ToolHive reference docs for v0.1.1 #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 30, 2025
Merged

Update ToolHive reference docs for v0.1.1 #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23edac3
Update ToolHive reference docs for v0.1.1
github-actions[bot] Jun 30, 2025
9e175c2
Update registry output examples
danbarr Jun 30, 2025
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
46 changes: 24 additions & 22 deletions docs/toolhive/guides-cli/registry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,24 @@ To list all MCP servers in the ToolHive registry, run:
thv registry list
```

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

Example output:

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

<... trimmed for brevity ...>
```
Expand Down Expand Up @@ -78,12 +77,15 @@ thv registry info <server-name> --format json

### Example output

```yaml {1,8,16,21} showLineNumbers
```yaml {1,11,19,24} showLineNumbers
Name: github
Image: ghcr.io/github/github-mcp-server:latest
Description: The GitHub MCP Server provides seamless integration with GitHub APIs, enabling advanced automation and interaction capabilities for developers and tools
Tier: Official
Status: Active
Transport: stdio
Repository URL: https://github.com/github/github-mcp-server
Has Provenance: Yes
Popularity: 13894 stars, 5000 pulls
Last Updated: 2025-05-20T00:21:46Z
Tools:
Expand Down Expand Up @@ -113,13 +115,13 @@ and security profile before running it.

- **Server name** (line 1): The server name to use with the
[`thv run`](../reference/cli/thv_run.md) command
- **Metadata** (lines 2-7): Details about the server, including the image name,
description, transport method, repository URL, popularity, and last updated
date
- **Tools list** (line 8): The list of tools this MCP server provides
- **Configuration** (line 16): Required and optional environment variables
- **Metadata** (lines 2-10): Details about the server, including the image name,
description, status, transport method, repository URL, whether the server has
SLSA provenance available for verification, and popularity
- **Tools list** (line 11): The list of tools this MCP server provides
- **Configuration** (line 19): Required and optional environment variables
needed to run the server
- **Permissions** (line 21): The permission profile applied to the server,
- **Permissions** (line 24): The permission profile applied to the server,
including file system and network access (see
[Custom permissions](./custom-permissions.mdx))

Expand Down
3 changes: 2 additions & 1 deletion docs/toolhive/reference/cli/thv_config_set-registry-url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ thv config set-registry-url <url> [flags]
### Options

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

### Options inherited from parent commands
Expand Down
13 changes: 7 additions & 6 deletions docs/toolhive/tutorials/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,10 +142,11 @@ thv registry list
You'll see output similar to this:

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

Expand Down Expand Up @@ -212,8 +213,8 @@ thv list
You should see output similar to this:

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

This confirms that the fetch server is running and available on port 49226.
Expand Down
12 changes: 10 additions & 2 deletions static/api-specs/toolhive-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,10 @@ components:
description: RepositoryURL is the URL to the source code repository for
the server
type: string
status:
description: The Status indicates whether the server is currently active
or deprecated
type: string
tags:
description: Tags are categorization labels for the server to aid in discovery
and filtering
Expand All @@ -177,8 +181,12 @@ components:
uniqueItems: false
target_port:
description: TargetPort is the port for the container to expose (only applicable
to SSE transport)
to SSE and Streamable HTTP transports)
type: integer
tier:
description: Tier represents the tier classification level of the server,
e.g., "official" or "community" driven
type: string
tools:
description: Tools is a list of tool names provided by this MCP server
items:
Expand All @@ -187,7 +195,7 @@ components:
uniqueItems: false
transport:
description: Transport defines the communication protocol for the server
(stdio or sse)
(stdio, sse, or streamable-http)
type: string
type: object
registry.Metadata:
Expand Down
Loading