Toolhive

🚀 ToolHive - Usage Guide

ToolHive is a powerful tool that simplifies the deployment and management of MCP servers. It offers a wide range of features, including custom permission settings, support for various programming languages, and seamless integration with Kubernetes.

🚀 Quick Start

📦 Installation

You can quickly install ToolHive using the following command:

curl -L https://github.com/stacklok/toolhive/releases/download/v0.1.0/toolhive-linux-amd64.gz | zcat > /usr/local/bin/toolhive && chmod +x /usr/local/bin/toolhive

💻 Usage Examples

🔍 Basic Usage

▶️ Running an MCP Server

ToolHive supports running an MCP server using the following command:

toolhive run --transport stdio --name my-mcp-server --port 8080 ./mcp_server.py

Alternatively, you can run it directly using a protocol scheme:

toolhive run uvx://awslabs.core-mcp-server@latest

🔒 Custom Permissions

ToolHive provides a JSON-based permission configuration file, which can be specified using the --permission-profile flag. For example:

{
  "read": ["/var/run/mcp.sock"],
  "write": ["/var/run/mcp.sock"],
  "network": {
    "outbound": {
      "insecure_allow_all": false,
      "allow_transport": ["tcp", "udp"],
      "allow_host": ["localhost", "google.com"],
      "allow_port": [80, 443]
    }
  }
}

🛸 Running in Kubernetes

ToolHive supports deploying MCP servers in a Kubernetes cluster. For more detailed information, please refer to: Running ToolHive in a kind Cluster

⚙️ Advanced Usage

🛠️ Custom Builds

ToolHive supports running MCP servers fetched from package managers directly through protocol schemes:

• uvx://: For Python-based MCP servers
• npx://: For Node.js-based MCP servers
• go://: For Go-based MCP servers

For example:

toolhive run go://github.com/example/go-mcp-server@latest

🌟 Advanced Features

ToolHive offers a rich set of advanced features, including:

• Container resource limits
• Network policies
• Log collection
• Monitoring integration

🤝 Contribution Guide

We welcome contributions from the community! Please refer to CONTRIBUTING.md to learn how to get involved.

📄 License

This project is licensed under the Apache 2.0 license. Please refer to the LICENSE file for detailed information.