Skip to content

Commit c090631

Browse files
authored
docs: replace inline quickstart with docs links (#573)
1 parent 3d0e37c commit c090631

File tree

1 file changed

+7
-60
lines changed

1 file changed

+7
-60
lines changed

README.md

Lines changed: 7 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,10 @@ setup, no security headaches, no runtime hassles.
3232

3333
## Quick links
3434

35-
- 🚀 [Quickstart](#getting-started) - install ToolHive and run your first MCP
36-
server
37-
<!-- - 📚 [Documentation](https://docs.stacklok.com/toolhive/) -->
35+
- 🚀 [Quickstart](https://docs.stacklok.com/toolhive/tutorials/quickstart-ui) -
36+
install ToolHive and run your first MCP server
37+
- 📚 [Documentation](https://docs.stacklok.com/toolhive/) - learn more about
38+
ToolHive's features
3839
- 💬 [Discord community](https://discord.gg/stacklok) - connect with the
3940
ToolHive community, ask questions, and share your experiences
4041
- 🛠️ [Developer guide](./docs/README.md) - build, test, and contribute to the
@@ -70,63 +71,9 @@ setup, no security headaches, no runtime hassles.
7071

7172
## Getting started
7273

73-
### Prerequisites
74-
75-
- [Docker](https://www.docker.com/) or [Podman](https://podman.io/) installed
76-
and running (Docker Desktop / Podman Desktop are recommended)
77-
- If you are using Linux, make sure your user is in the `docker` group
78-
([reference](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user)).
79-
80-
### Install ToolHive
81-
82-
Download and install the latest release of the ToolHive for your platform:
83-
84-
- macOS (Apple Silicon):
85-
[download the DMG file](https://github.com/stacklok/toolhive-studio/releases/latest/download/ToolHive.dmg),
86-
open it, and drag the ToolHive app to your Applications folder.
87-
- Windows:
88-
[download the installer](https://github.com/stacklok/toolhive-studio/releases/latest/download/ToolHive.Setup.exe)
89-
and run it.
90-
> [!NOTE]
91-
> The Windows installer is not digitally signed yet, so you might need to
92-
> accept warnings from Windows Defender SmartScreen. We're working on getting
93-
> signing set up soon.
94-
- Linux: download the RPM or DEB package from the
95-
[releases page](https://github.com/stacklok/toolhive-studio/releases/latest)
96-
and install it using your package manager.
97-
98-
### Run your first MCP server
99-
100-
The ToolHive UI has four main areas:
101-
102-
- **Installed**: View and manage your installed MCP servers.
103-
- **Registry**: Browse and install servers from the curated registry of official
104-
and community servers.
105-
- **Clients**: Automatically connect your favorite clients to MCP servers.
106-
- **Secrets**: Securely manage sensitive data required by many MCP servers.
107-
108-
Start by installing a simple MCP server from the registry:
109-
110-
1. On the **Installed** tab, click **Add server** and choose **From the
111-
registry**. Or, open the **Registry** tab to browse available servers.
112-
113-
2. Select the "fetch" server from the list. Fetch is a simple MCP server that
114-
fetches data from the web.
115-
116-
![ToolHive registry](docs/images/quickstart-2.webp)
117-
118-
3. Click **Install server** to start the server.
119-
120-
4. Once the server is running, click **View** on the notification or open the
121-
**Installed** tab to see its status.
122-
123-
5. Open the **Clients** tab to connect your favorite client (e.g., GitHub
124-
Copilot, Cursor, Claude Code). For a list of supported clients, see the
125-
[ToolHive documentation](https://docs.stacklok.com/toolhive/reference/client-compatibility).
126-
127-
6. Open your client and start using the MCP server!
128-
129-
![Cursor MCP servers](docs/images/quickstart-7.webp)
74+
To get started with ToolHive, download the latest release from
75+
[the website](https://toolhive.dev/download.html) and follow the
76+
[quickstart guide](https://docs.stacklok.com/toolhive/tutorials/quickstart-ui).
13077

13178
---
13279

0 commit comments

Comments
 (0)