ToolRegistry Server¶

Serve custom tools via OpenAPI and MCP for function-calling LLMs. Built on ToolRegistry.

Overview¶

toolregistry-server lets you register Python functions as tools and expose them as services through multiple protocols — REST APIs via OpenAPI and LLM integration via the Model Context Protocol.

Ecosystem¶

The ToolRegistry ecosystem consists of three packages:

Package	Description
`toolregistry`	Core library - Tool model, ToolRegistry, client integration
`toolregistry-server`	Tool server - define tools and serve via OpenAPI/MCP
`toolregistry-hub`	Tool collection - Built-in tools, default server configuration

toolregistry (core)
       ↓
toolregistry-server (tool server)
       ↓
toolregistry-hub (tool collection + server config)

See the Ecosystem page for a detailed overview of all packages.

Quick Start¶

pip install toolregistry-server[all]

from toolregistry import ToolRegistry
from toolregistry_server import RouteTable
from toolregistry_server.openapi import create_openapi_app

# Create a registry and register tools
registry = ToolRegistry()

@registry.register
def greet(name: str) -> str:
    """Greet someone by name."""
    return f"Hello, {name}!"

# Create route table and FastAPI app
route_table = RouteTable(registry)
app = create_openapi_app(route_table)

Installation Guide → | Quick Start →

Key Features¶

Central Route Table: A unified routing layer that bridges ToolRegistry and protocol adapters
OpenAPI Adapter: Expose tools as RESTful HTTP endpoints with automatic OpenAPI schema generation
MCP Adapter: Expose tools via the Model Context Protocol for LLM integration
Authentication: Built-in Bearer token authentication support
CLI: Command-line interface for running servers without custom code
Dynamic Enable/Disable: Runtime tool state management without server restart
ETag Caching: HTTP caching via ETag headers for efficient API responses

Architecture¶

graph TD
    TR[ToolRegistry<br/>tool definitions]
    RT[RouteTable<br/>central routing layer<br/><i>RouteEntry · RouteEntry · ...</i>]
    OA[OpenAPI Adapter<br/>FastAPI · REST]
    MA[MCP Adapter<br/>MCP SDK · LLM integration]
    GA[gRPC Adapter<br/>future]

    TR --> RT
    RT --> OA
    RT --> MA
    RT -.-> GA

Documentation Contents¶

Installation Guide - Install toolregistry-server with optional extras
Quick Start - Get up and running in minutes
Configuration - JSON/JSONC configuration for the CLI
Authentication - Bearer token authentication setup
Adapters - OpenAPI and MCP protocol adapters
CLI Reference - Command-line interface usage
API Reference - Comprehensive API documentation

License¶

ToolRegistry Server is licensed under the MIT License.