|
| 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 server](https://discord.gg/stacklok) to connect with |
| 93 | +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/StacklokLabs/toolhive-ui). |
| 103 | +When 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. |
0 commit comments