@@ -38,7 +38,7 @@ Select your operating system to see the installation instructions.
38
38
Download the latest ToolHive installer for
39
39
[ Apple silicon] ( https://github.com/stacklok/toolhive-studio/releases/latest/download/ToolHive-arm64.dmg )
40
40
or
41
- [ Intel-based] ( https://github.com/stacklok/toolhive-studio/releases/latest/download/ToolHive-arm64 .dmg )
41
+ [ Intel-based] ( https://github.com/stacklok/toolhive-studio/releases/latest/download/ToolHive-x64 .dmg )
42
42
Macs and open the DMG file.
43
43
44
44
Copy the ToolHive app to your Applications folder. You can then open it from
@@ -53,8 +53,8 @@ and run the setup executable.
53
53
54
54
:::note
55
55
56
- The Windows installer is not digitally signed yet, so you will need to accept
57
- the warning from Windows Defender SmartScreen. We're working on getting a signed
56
+ The Windows installer is not digitally signed yet, so you'll need to accept the
57
+ warning from Windows Defender SmartScreen. We're working on getting a signed
58
58
installer published soon.
59
59
60
60
:::
@@ -96,22 +96,31 @@ and extract it, then run the `ToolHive` binary directly.
96
96
97
97
## System tray icon
98
98
99
- When you close the ToolHive application window, it stays running in the
99
+ When you close the ToolHive application window, it continues running in the
100
100
background so your MCP servers remain available. ToolHive installs a system tray
101
101
icon for quick access. You can use it to:
102
102
103
103
- Enable or disable ** Start on login**
104
104
- Show or hide the ToolHive application window
105
105
- Quit ToolHive, which stops all running MCP servers
106
106
107
- ## Run ToolHive on login
107
+ ## Application settings
108
108
109
- You can configure ToolHive to start automatically when you log in to your
110
- system. This is useful if you want your MCP servers to be available without
111
- manually starting ToolHive each time.
109
+ Open the ToolHive settings screen from the gear icon (⚙️) in the application
110
+ window. The settings screen allows you to configure various options:
112
111
113
- To enable this feature, turn on the ** Start on login** option in the system tray
114
- icon menu or in the settings menu (⚙️) in the application.
112
+ - ** Display theme** : Choose between light and dark themes for the application.
113
+ ToolHive matches your system theme by default.
114
+ - ** Start on login** : Automatically start ToolHive when you log in to your
115
+ system. MCP servers that were running when you quit ToolHive are restarted
116
+ automatically.
117
+ - ** Error reporting** : Enable or disable error reporting and telemetry data
118
+ collection.
119
+ - ** Skip quit confirmation** : Skip the MCP server shutdown confirmation dialog
120
+ when quitting ToolHive.
121
+
122
+ From the settings screen, you can also view version information and download the
123
+ application log file for troubleshooting.
115
124
116
125
## Upgrade ToolHive
117
126
@@ -178,13 +187,16 @@ configuration file and secrets store to support coexistence.
178
187
</TabItem >
179
188
</Tabs >
180
189
190
+ You can also download the application log file from the ** Settings** screen (⚙️)
191
+ in the ToolHive UI.
192
+
181
193
## Telemetry and error reporting
182
194
183
195
ToolHive uses [ Sentry] ( https://sentry.io/welcome/ ) for error tracking and
184
196
performance monitoring to help us identify and fix issues, improve stability,
185
197
and enhance the user experience. This telemetry is enabled by default. You can
186
- disable this by turning off the ** Error reporting** option in the settings menu
187
- (⚙️) if you prefer not to share this data.
198
+ disable this by turning off the ** Error reporting** option in the settings
199
+ screen (⚙️) if you prefer not to share this data.
188
200
189
201
ToolHive collects the following information:
190
202
@@ -215,15 +227,15 @@ MCP servers. See [Run MCP servers](./run-mcp-servers.md) to get started.
215
227
<details >
216
228
<summary >Connection Refused error on startup</summary >
217
229
218
- If you see a "Connection Refused" error when starting ToolHive, it's likely
219
- because your container runtime (Docker or Podman) is not installed, not running,
220
- or not configured correctly.
230
+ If you see a "Connection Refused" error when starting ToolHive, your container
231
+ runtime (Docker or Podman) is likely not installed, not running, or not
232
+ configured correctly.
221
233
222
- Follow the instructions on the error message to install or start your container
223
- runtime. For example, if you're using Docker Desktop, make sure it is running
224
- and that the Docker daemon is active.
234
+ Follow the instructions in the error message to install or start your container
235
+ runtime. For example, if you're using Docker Desktop, make sure it's running and
236
+ that the Docker daemon is active.
225
237
226
- If the retry button doesn't work, try restarting ToolHive.
238
+ If the retry button doesn't work, restart ToolHive.
227
239
228
240
</details >
229
241
0 commit comments