Skip to content

Commit a32061d

Browse files
authored
Add documentation for Usage Metrics (#286)
Signed-off-by: lujunsan <[email protected]>
1 parent 6d4c78b commit a32061d

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

docs/toolhive/faq.mdx

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,45 @@ Kubernetes cluster to use it with the operator.
7878

7979
:::
8080

81+
## Privacy and data collection
82+
83+
### Does ToolHive collect any data?
84+
85+
ToolHive collects anonymous usage metrics to help improve the product. These
86+
metrics include only tool call counts and are completely anonymous. No personal
87+
information, user identifiers, or sensitive data is collected.
88+
89+
The metrics collection:
90+
91+
- Is enabled by default
92+
- Only tracks the number of tool calls
93+
- Uses a randomly generated instance ID (not tied to your identity)
94+
- Is automatically disabled in CI environments
95+
- Can be easily disabled
96+
97+
### How do I disable usage metrics?
98+
99+
You can opt out of usage metrics collection in two ways:
100+
101+
**Option 1: Persistent configuration (recommended)**
102+
103+
Use the ToolHive CLI to disable metrics permanently:
104+
105+
```bash
106+
thv config usage-metrics disable
107+
```
108+
109+
**Option 2: Environment variable**
110+
111+
Set an environment variable to disable metrics for the current session:
112+
113+
```bash
114+
export TOOLHIVE_USAGE_METRICS_ENABLED=false
115+
```
116+
117+
Once you opt out, ToolHive stops collecting and sending usage metrics. You need
118+
to restart any running servers for the change to take effect.
119+
81120
## Security and permissions
82121

83122
### Is it safe to run MCP servers?

docs/toolhive/guides-cli/install.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,15 @@ Go version: go1.24.1
155155
Platform: darwin/arm64
156156
```
157157

158+
:::info[Privacy: Anonymous usage metrics]
159+
160+
ToolHive collects anonymous usage metrics (tool call counts only) to help
161+
improve the product. No personal information or sensitive data is collected. You
162+
can disable this at any time using `thv config usage-metrics disable`. For more
163+
information, see the [FAQ](../faq.mdx#does-toolhive-collect-any-data).
164+
165+
:::
166+
158167
## Upgrade ToolHive
159168

160169
ToolHive automatically checks for updates and notifies you when a new version is

0 commit comments

Comments
 (0)