Skip to content

Commit 640e464

Browse files
authored
Add support page (#351)
* Fix some random formatting and linting issues * Add support page --------- Signed-off-by: Dan Barr <[email protected]> Co-authored-by: Dan Barr <[email protected]>
1 parent b787217 commit 640e464

File tree

6 files changed

+165
-42
lines changed

6 files changed

+165
-42
lines changed

.github/copilot-instructions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ This is the user-facing documentation for ToolHive, an open source tool that hel
2323

2424
Code quality tools:
2525

26-
- Prettier for code formatting - `npm run prettier` to check, `npm run prettier:fix` to auto-fix.
27-
- markdownlint for enforcing Markdown style conventions - `npm run markdownlint` to check, `npm run markdownlint:fix` to auto-fix.
28-
- ESLint for JavaScript/TypeScript linting - `npm run eslint` to check, `npm run eslint:fix` to auto-fix.
26+
- All files: Prettier for code formatting - `npm run prettier` to check, `npm run prettier:fix` to auto-fix.
27+
- markdownlint for enforcing Markdown style conventions - `npm run markdownlint` to check, `npm run markdownlint:fix` to auto-fix (`.md` files only).
28+
- ESLint for JavaScript/TypeScript and MDX linting - `npm run eslint` to check, `npm run eslint:fix` to auto-fix.
2929

3030
## Audience
3131

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ This is the user-facing documentation for ToolHive, an open source tool that hel
2323

2424
Code quality tools:
2525

26-
- Prettier for code formatting - `npm run prettier` to check, `npm run prettier:fix` to auto-fix.
27-
- markdownlint for enforcing Markdown style conventions - `npm run markdownlint` to check, `npm run markdownlint:fix` to auto-fix.
28-
- ESLint for JavaScript/TypeScript linting - `npm run eslint` to check, `npm run eslint:fix` to auto-fix.
26+
- All files: Prettier for code formatting - `npm run prettier` to check, `npm run prettier:fix` to auto-fix.
27+
- markdownlint for enforcing Markdown style conventions - `npm run markdownlint` to check, `npm run markdownlint:fix` to auto-fix (`.md` files only).
28+
- ESLint for JavaScript/TypeScript and MDX linting - `npm run eslint` to check, `npm run eslint:fix` to auto-fix.
2929

3030
## Audience
3131

docs/toolhive/guides-ui/playground.mdx

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -59,32 +59,35 @@ To start using the playground:
5959

6060
3. **Select MCP tools**: Click the tools icon to manage which MCP servers and
6161
tools are available in the playground.
62-
63-
<ThemedImage
64-
alt='ToolHive playground tools management showing available MCP tools'
65-
sources={{
66-
light: useBaseUrl(
67-
'/img/toolhive/toolhive-ui-playground-thv-mcp-light.webp'
68-
),
69-
dark: useBaseUrl('/img/toolhive/toolhive-ui-playground-thv-mcp-dark.webp'),
70-
}}
71-
title='MCP tools management interface'
72-
/>
73-
74-
- View all your running MCP servers
75-
- Enable or disable specific tools from each server
76-
- Search and filter tools by name or functionality
77-
- The `toolhive mcp` server is included by default, providing management
78-
capabilities
79-
80-
:::tip
81-
82-
For more control over tool availability, use
83-
[Customize tools](./customize-tools.mdx) to permanently configure which tools
84-
are enabled for each registry server. The playground tool selection is temporary
85-
and only affects your testing session.
86-
87-
:::
62+
- View all your running MCP servers
63+
- Enable or disable specific tools from each server
64+
- Search and filter tools by name or functionality
65+
- The `toolhive mcp` server is included by default, providing management
66+
capabilities
67+
68+
<ThemedImage
69+
alt='ToolHive playground tools management showing available MCP tools'
70+
width='900px'
71+
style={{ 'margin-top': '16px' }}
72+
sources={{
73+
light: useBaseUrl(
74+
'/img/toolhive/toolhive-ui-playground-thv-mcp-light.webp'
75+
),
76+
dark: useBaseUrl(
77+
'/img/toolhive/toolhive-ui-playground-thv-mcp-dark.webp'
78+
),
79+
}}
80+
title='MCP tools management interface'
81+
/>
82+
83+
:::tip
84+
85+
For more control over tool availability, use
86+
[Customize tools](./customize-tools.mdx) to permanently configure which tools
87+
are enabled for each registry server. The playground tool selection is
88+
temporary and only affects your testing session.
89+
90+
:::
8891

8992
4. **Start testing**: Begin chatting with your chosen AI model. The model will
9093
have access to all enabled MCP tools and can execute them based on your
@@ -105,6 +108,7 @@ a comprehensive overview of your server status.
105108

106109
<ThemedImage
107110
alt='ToolHive playground showing AI response with MCP tool execution results'
111+
width='900px'
108112
sources={{
109113
light: useBaseUrl(
110114
'/img/toolhive/toolhive-ui-playground-chat-response-light.webp'

docs/toolhive/support.mdx

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
title: Getting support
3+
sidebar_label: Support
4+
description: How to get help and support for ToolHive
5+
---
6+
7+
Whether you're troubleshooting an issue, looking for guidance, or need help with
8+
your ToolHive deployment, there are several ways to get support. This page
9+
outlines the available resources to help you find answers quickly.
10+
11+
## Self-help resources
12+
13+
### Documentation
14+
15+
This documentation site is your first stop for help. You can search using
16+
keywords or ask questions using AI-powered search:
17+
18+
- **Keyword search**: Use the search bar at the top of the page to find specific
19+
topics, commands, or configuration options.
20+
- **AI search**: Type a question in the search and select the **Ask AI** option
21+
to get relevant answers from the documentation.
22+
23+
### ToolHive documentation MCP server
24+
25+
For an enhanced documentation experience, you can use the ToolHive documentation
26+
search MCP server. This server provides access to the ToolHive documentation
27+
directly within your AI-powered tools, making it easy to get context-aware help
28+
while you work.
29+
30+
ToolHive offers two ways to access the documentation server:
31+
32+
- **`toolhive-doc-mcp-remote`** (recommended): A hosted remote MCP server that's
33+
always up-to-date with the latest documentation.
34+
- **`toolhive-doc-mcp`**: A containerized local version you can run on your
35+
machine.
36+
37+
Both versions are available in the ToolHive registry. The
38+
[`toolhive-doc-mcp`](https://github.com/StacklokLabs/toolhive-doc-mcp) source
39+
code is available on GitHub.
40+
41+
:::tip
42+
43+
Once you've added the ToolHive documentation MCP server, you can ask your AI
44+
assistant questions like "How do I configure ToolHive?" or "What are the
45+
available commands?" and get answers directly from the documentation.
46+
47+
:::
48+
49+
#### Using with the ToolHive UI
50+
51+
1. Open the ToolHive UI application.
52+
2. Open the **Registry** page.
53+
3. Search for `toolhive-doc` to find both versions.
54+
4. Select `toolhive-doc-mcp-remote` (recommended) or `toolhive-doc-mcp` (local).
55+
5. Review the pre-filled configuration and click **Install server** to start the
56+
MCP server.
57+
58+
The server will appear on the MCP Servers page with a "Running" status. The
59+
documentation is now available to your connected AI clients.
60+
61+
See the [Run MCP servers](./guides-ui/run-mcp-servers.mdx) guide for more
62+
details.
63+
64+
#### Using with the ToolHive CLI
65+
66+
To run the hosted remote version (recommended):
67+
68+
```bash
69+
thv run toolhive-doc-mcp-remote
70+
```
71+
72+
Or to run the local containerized version:
73+
74+
```bash
75+
thv run toolhive-doc-mcp
76+
```
77+
78+
Once started, the documentation will be available to any AI clients registered
79+
with ToolHive. To verify the server is running:
80+
81+
```bash
82+
thv list
83+
```
84+
85+
See the [Run MCP servers](./guides-cli/run-mcp-servers.mdx) guide for more
86+
details.
87+
88+
## Community support
89+
90+
### Discord
91+
92+
Join the [Stacklok Discord community](https://discord.gg/stacklok) to connect
93+
with the ToolHive community. The `#user-chat` channel is the place to ask usage
94+
questions, share tips, and get help from other users and the Stacklok team.
95+
96+
You can also ask questions to the `@stacklok-bot` chatbot in Discord. The bot
97+
can help answer common questions and provide guidance on using ToolHive.
98+
99+
### GitHub issues
100+
101+
If you've found a bug or want to request a new feature, please open an issue on
102+
the [ToolHive GitHub repository](https://github.com/stacklok/toolhive). When
103+
reporting a bug, include as much detail as possible, such as:
104+
105+
- Your operating system and version
106+
- The version of ToolHive you're using
107+
- Steps to reproduce the issue
108+
- Any error messages or logs
109+
110+
This information helps the team diagnose and fix issues more quickly.
111+
112+
## Enterprise support
113+
114+
For organizations that need dedicated support, custom integrations, or
115+
assistance with large-scale deployments, enterprise support is available.
116+
Contact the Stacklok team at
117+
[[email protected]](mailto:[email protected]) to discuss your needs.

docs/toolhive/tutorials/quickstart-k8s.mdx

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -225,18 +225,19 @@ Configure Visual Studio Code to connect to your MCP server. Open VS Code and
225225
access your user settings:
226226

227227
1. Open the command palette (Cmd/Ctrl+Shift+P)
228+
228229
2. Type "MCP: Add Server..." and select it
229230

230-
<ThemedImage
231-
alt='VS Code user settings in command palette'
232-
sources={{
233-
light: useBaseUrl('/img/toolhive/quickstart/vscode-settings-light.webp'),
234-
dark: useBaseUrl('/img/toolhive/quickstart/vscode-settings-dark.webp'),
235-
}}
236-
title='VS Code user settings in command palette'
237-
width='800'
238-
className='screenshot'
239-
/>
231+
<ThemedImage
232+
alt='VS Code user settings in command palette'
233+
sources={{
234+
light: useBaseUrl('/img/toolhive/quickstart/vscode-settings-light.webp'),
235+
dark: useBaseUrl('/img/toolhive/quickstart/vscode-settings-dark.webp'),
236+
}}
237+
title='VS Code user settings in command palette'
238+
width='800'
239+
className='screenshot'
240+
/>
240241

241242
3. Select "HTTP" as the server type
242243

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,7 @@ const sidebars: SidebarsConfig = {
224224
},
225225

226226
'toolhive/faq',
227+
'toolhive/support',
227228
'toolhive/contributing',
228229
],
229230
};

0 commit comments

Comments
 (0)