Skip to content

Conversation

@samuv
Copy link
Contributor

@samuv samuv commented Oct 2, 2025

Documenting the playground Feature

Description

This PR provides comprehensive documentation for the new Playground feature. The Playground allows you to test and validate your MCP servers directly inside the ToolHive UI, removing the need for external client setup. This makes it significantly faster to check server functionality and behavior.

The following content has been added and updated:

  • A new page, docs/toolhive/guides-ui/playground.mdx, contains all the documentation.
  • The sidebar structure has been updated in /sidebars.ts to include the new page.
  • The content covers the step-by-step process, from API key configuration to managing servers via conversational AI.

New Documentation Content:

The page specifically details these key capabilities:

  • Instant Testing: You can immediately begin testing MCP servers after setting the required API keys.
  • Transparent Audit Logs: Visibility into tool execution, parameters, and responses.
  • Integrated Management: You can manage your running MCP servers using natural language commands; for example, you can ask to Analyze the logs of the fetch MCP server for me.

Screenshots

The documentation uses 2 sets of ThemedImage components to show the following steps, ensuring consistency across light and dark modes:

  • MCP tool selection and management (toolhive-ui-playground-thv-mcp-*.webp)
  • Tool execution results and responses (toolhive-ui-playground-chat-response-*.webp)

Content

  • Front matter includes, at a minimum, a title and description.
  • Sidebar navigation in /sidebars.ts is updated.
  • Redirects added to /vercel.json for moved pages. (N/A) - This is a new page.

Reviews

  • Content has been reviewed for technical accuracy.
  • Content has been reviewed for adherence to the writing style guide (tone, voice, and formatting).

Copilot AI review requested due to automatic review settings October 2, 2025 14:50
@vercel
Copy link

vercel bot commented Oct 2, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs-website Ready Ready Preview Comment Oct 3, 2025 8:01am

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation for ToolHive's new Playground feature, which enables users to test and validate MCP servers directly within the ToolHive UI using AI model providers. The documentation provides step-by-step guidance for configuring API keys, managing MCP tools, and leveraging conversational AI for server management.

Key changes:

  • New documentation page explaining Playground functionality and workflows
  • Updated sidebar navigation to include the Playground guide
  • Five sets of themed screenshots demonstrating the complete user workflow

Reviewed Changes

Copilot reviewed 2 out of 12 changed files in this pull request and generated 2 comments.

File Description
sidebars.ts Added playground guide to the UI guides section in the sidebar navigation
docs/toolhive/guides-ui/playground.mdx Comprehensive documentation covering Playground setup, usage, best practices, and troubleshooting

Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
samuv and others added 11 commits October 2, 2025 19:12
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
Co-authored-by: Dan Barr <danbarr@users.noreply.github.com>
@samuv samuv merged commit 1ea85c8 into main Oct 3, 2025
6 checks passed
@samuv samuv deleted the playground-doc branch October 3, 2025 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants