Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ This is the user-facing documentation for ToolHive, an open source tool that hel

Code quality tools:

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

## Audience

Expand Down
6 changes: 3 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ This is the user-facing documentation for ToolHive, an open source tool that hel

Code quality tools:

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

## Audience

Expand Down
56 changes: 30 additions & 26 deletions docs/toolhive/guides-ui/playground.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,32 +59,35 @@ To start using the playground:

3. **Select MCP tools**: Click the tools icon to manage which MCP servers and
tools are available in the playground.

<ThemedImage
alt='ToolHive playground tools management showing available MCP tools'
sources={{
light: useBaseUrl(
'/img/toolhive/toolhive-ui-playground-thv-mcp-light.webp'
),
dark: useBaseUrl('/img/toolhive/toolhive-ui-playground-thv-mcp-dark.webp'),
}}
title='MCP tools management interface'
/>

- View all your running MCP servers
- Enable or disable specific tools from each server
- Search and filter tools by name or functionality
- The `toolhive mcp` server is included by default, providing management
capabilities

:::tip

For more control over tool availability, use
[Customize tools](./customize-tools.mdx) to permanently configure which tools
are enabled for each registry server. The playground tool selection is temporary
and only affects your testing session.

:::
- View all your running MCP servers
- Enable or disable specific tools from each server
- Search and filter tools by name or functionality
- The `toolhive mcp` server is included by default, providing management
capabilities

<ThemedImage
alt='ToolHive playground tools management showing available MCP tools'
width='900px'
style={{ 'margin-top': '16px' }}
sources={{
light: useBaseUrl(
'/img/toolhive/toolhive-ui-playground-thv-mcp-light.webp'
),
dark: useBaseUrl(
'/img/toolhive/toolhive-ui-playground-thv-mcp-dark.webp'
),
}}
title='MCP tools management interface'
/>

:::tip

For more control over tool availability, use
[Customize tools](./customize-tools.mdx) to permanently configure which tools
are enabled for each registry server. The playground tool selection is
temporary and only affects your testing session.

:::

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

<ThemedImage
alt='ToolHive playground showing AI response with MCP tool execution results'
width='900px'
sources={{
light: useBaseUrl(
'/img/toolhive/toolhive-ui-playground-chat-response-light.webp'
Expand Down
117 changes: 117 additions & 0 deletions docs/toolhive/support.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
title: Getting support
sidebar_label: Support
description: How to get help and support for ToolHive
---

Whether you're troubleshooting an issue, looking for guidance, or need help with
your ToolHive deployment, there are several ways to get support. This page
outlines the available resources to help you find answers quickly.

## Self-help resources

### Documentation

This documentation site is your first stop for help. You can search using
keywords or ask questions using AI-powered search:

- **Keyword search**: Use the search bar at the top of the page to find specific
topics, commands, or configuration options.
- **AI search**: Type a question in the search and select the **Ask AI** option
to get relevant answers from the documentation.

### ToolHive documentation MCP server

For an enhanced documentation experience, you can use the ToolHive documentation
search MCP server. This server provides access to the ToolHive documentation
directly within your AI-powered tools, making it easy to get context-aware help
while you work.

ToolHive offers two ways to access the documentation server:

- **`toolhive-doc-mcp-remote`** (recommended): A hosted remote MCP server that's
always up-to-date with the latest documentation.
- **`toolhive-doc-mcp`**: A containerized local version you can run on your
machine.

Both versions are available in the ToolHive registry. The
[`toolhive-doc-mcp`](https://github.com/StacklokLabs/toolhive-doc-mcp) source
code is available on GitHub.

:::tip

Once you've added the ToolHive documentation MCP server, you can ask your AI
assistant questions like "How do I configure ToolHive?" or "What are the
available commands?" and get answers directly from the documentation.

:::

#### Using with the ToolHive UI

1. Open the ToolHive UI application.
2. Open the **Registry** page.
3. Search for `toolhive-doc` to find both versions.
4. Select `toolhive-doc-mcp-remote` (recommended) or `toolhive-doc-mcp` (local).
5. Review the pre-filled configuration and click **Install server** to start the
MCP server.

The server will appear on the MCP Servers page with a "Running" status. The
documentation is now available to your connected AI clients.

See the [Run MCP servers](./guides-ui/run-mcp-servers.mdx) guide for more
details.

#### Using with the ToolHive CLI

To run the hosted remote version (recommended):

```bash
thv run toolhive-doc-mcp-remote
```

Or to run the local containerized version:

```bash
thv run toolhive-doc-mcp
```

Once started, the documentation will be available to any AI clients registered
with ToolHive. To verify the server is running:

```bash
thv list
```

See the [Run MCP servers](./guides-cli/run-mcp-servers.mdx) guide for more
details.

## Community support

### Discord

Join the [Stacklok Discord community](https://discord.gg/stacklok) to connect
with the ToolHive community. The `#user-chat` channel is the place to ask usage
questions, share tips, and get help from other users and the Stacklok team.

You can also ask questions to the `@stacklok-bot` chatbot in Discord. The bot
can help answer common questions and provide guidance on using ToolHive.

### GitHub issues

If you've found a bug or want to request a new feature, please open an issue on
the [ToolHive GitHub repository](https://github.com/stacklok/toolhive). When
reporting a bug, include as much detail as possible, such as:

- Your operating system and version
- The version of ToolHive you're using
- Steps to reproduce the issue
- Any error messages or logs

This information helps the team diagnose and fix issues more quickly.

## Enterprise support

For organizations that need dedicated support, custom integrations, or
assistance with large-scale deployments, enterprise support is available.
Contact the Stacklok team at
[[email protected]](mailto:[email protected]) to discuss your needs.
21 changes: 11 additions & 10 deletions docs/toolhive/tutorials/quickstart-k8s.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -225,18 +225,19 @@ Configure Visual Studio Code to connect to your MCP server. Open VS Code and
access your user settings:

1. Open the command palette (Cmd/Ctrl+Shift+P)

2. Type "MCP: Add Server..." and select it

<ThemedImage
alt='VS Code user settings in command palette'
sources={{
light: useBaseUrl('/img/toolhive/quickstart/vscode-settings-light.webp'),
dark: useBaseUrl('/img/toolhive/quickstart/vscode-settings-dark.webp'),
}}
title='VS Code user settings in command palette'
width='800'
className='screenshot'
/>
<ThemedImage
alt='VS Code user settings in command palette'
sources={{
light: useBaseUrl('/img/toolhive/quickstart/vscode-settings-light.webp'),
dark: useBaseUrl('/img/toolhive/quickstart/vscode-settings-dark.webp'),
}}
title='VS Code user settings in command palette'
width='800'
className='screenshot'
/>

3. Select "HTTP" as the server type

Expand Down
1 change: 1 addition & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ const sidebars: SidebarsConfig = {
},

'toolhive/faq',
'toolhive/support',
'toolhive/contributing',
],
};
Expand Down