Skip to main content

toolregistry-server

PyPI version TestPyPI version CI License: MIT

Define custom tools and serve them via OpenAPI or MCP interfaces. Built on ToolRegistry.

Overview

toolregistry-server lets you register Python functions as tools and expose them as services through multiple protocols. It provides:

  • Registry Builder: Protocol-agnostic config loading and source registration (registry_builder)
  • Protocol Adapters: OpenAPIAdapter (FastAPI/REST) and MCPAdapter (Model Context Protocol)
  • App Orchestration: App class for building registries and dispatching to any adapter; subclass prepare_registry() for custom registries
  • Authentication: Unified Bearer token support (auth.load_tokens)
  • CLI: toolregistry-server openapi / toolregistry-server mcp with --config, --profile, and more

Ecosystem

Package Description PyPI TestPyPI Docs
toolregistry Core library — tool registration, schema generation, execution PyPI TestPyPI Docs
toolregistry-server Server adapters — expose tools via OpenAPI & MCP PyPI TestPyPI Docs
toolregistry-hub Ready-to-use tools — calculator, web search, file ops, etc. PyPI TestPyPI Docs
toolregistry (core)
       ↓
toolregistry-server (tool server)
       ↓
toolregistry-hub (tool collection + server config)

Installation

# Base (RouteTable, registry_builder, auth)
pip install toolregistry-server

# OpenAPI server (vendored httpserver, no extra needed)
pip install toolregistry-server

# With the ASGI gateway backend (FastAPI + uvicorn)
pip install toolregistry-server[gateway]

# With MCP support
pip install toolregistry-server[mcp]

# With bounded execution of spec-supplied regexes (optional)
pip install toolregistry-server[regex]

# Full
pip install toolregistry-server[all]

The regex extra is not part of all. Without it, spec-supplied pattern / patternProperties are not executed during request validation; with it, every match is bounded (50 ms per match, 250 ms per request by default) and a timeout answers 500. See the OpenAPI guide.

Quick Start

Programmatic — OpenAPI server

from toolregistry import ToolRegistry
from toolregistry_server import RouteTable
from toolregistry_server.adapters.openapi import OpenAPIAdapter

registry = ToolRegistry()

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

route_table = RouteTable(registry)
adapter = OpenAPIAdapter(route_table)
adapter.run(host="0.0.0.0", port=8000)

Programmatic — MCP server

import asyncio
from toolregistry import ToolRegistry
from toolregistry_server import RouteTable
from toolregistry_server.adapters.mcp import MCPAdapter

registry = ToolRegistry()
# ... register tools ...
route_table = RouteTable(registry)

adapter = MCPAdapter(route_table)
adapter.run(transport="stdio")                        # blocking
# or: asyncio.run(adapter.run_async(transport="sse", host="0.0.0.0", port=8000))

High-level — App class

from toolregistry_server.app import App

# From a config file
App().serve_openapi(config_path="tools.yaml", host="0.0.0.0", port=8000)
App().serve_mcp(config_path="tools.yaml", transport="stdio")

# From a pre-built registry
from toolregistry import ToolRegistry
registry = ToolRegistry()
# ... register tools ...
App().serve_openapi(registry=registry, port=9000)

Custom App subclass

Override prepare_registry to add built-in tools, hooks, or metadata:

from toolregistry_server.app import App

class MyApp(App):
    def prepare_registry(self, **kwargs):
        from toolregistry import ToolRegistry
        registry = ToolRegistry()
        registry.register(my_builtin_tool)
        # optionally apply user config on top
        if kwargs.get("config_path"):
            from toolregistry_server import apply_config, load_config
            apply_config(registry, load_config(kwargs["config_path"]))
        return registry

MyApp().serve_openapi(host="0.0.0.0", port=8000)

CLI

# OpenAPI server from config file
toolregistry-server openapi --config tools.yaml --port 8000

# MCP server (stdio)
toolregistry-server mcp --config tools.yaml --transport stdio

# MCP server (SSE)
toolregistry-server mcp --config tools.yaml --transport sse --port 8000

# With deployment profile (disables network/filesystem tools)
toolregistry-server openapi --config tools.yaml --profile remote

# With Bearer token auth
toolregistry-server openapi --config tools.yaml --tokens /path/to/tokens.txt

Config File

JSONC and YAML are both supported. Three source types: python, mcp, openapi.

mode: denylist     # or "allowlist"
disabled: []       # namespaces to exclude (denylist mode)

tools:
  # Python module — all public functions
  - type: python
    module: my_package.tools
    namespace: my_tools

  # Python class
  - type: python
    class: my_package.Calculator
    namespace: calculator

  # MCP server (stdio subprocess)
  - type: mcp
    transport: stdio
    command: ["python", "-m", "my_mcp_server"]
    namespace: mcp_tools

  # MCP server (SSE / streamable-http)
  - type: mcp
    transport: http
    url: http://localhost:8080/mcp
    namespace: remote_mcp

  # OpenAPI endpoint
  - type: openapi
    url: https://api.example.com/openapi.json
    namespace: external_api
    auth:
      type: bearer
      token_env: EXTERNAL_API_TOKEN

See examples/config.yaml and examples/config.jsonc for full examples.

Architecture

┌─────────────────────────────────────────────────────────────┐
│                    registry_builder                         │
│   load_config · apply_config · register_*_source            │
│   apply_profile · PROFILE_DISABLE_TAGS                      │
└─────────────────────────┬───────────────────────────────────┘
                          │
                          ▼
┌─────────────────────────────────────────────────────────────┐
│                       RouteTable                            │
│              (central routing layer)                        │
└─────────────────────────┬───────────────────────────────────┘
                          │
          ┌───────────────┼───────────────┐
          ▼               ▼               ▼
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
│  OpenAPIAdapter │ │   MCPAdapter    │ │  (your adapter) │
│   (FastAPI)     │ │  stdio/sse/http │ │  Adapter ABC    │
└─────────────────┘ └─────────────────┘ └─────────────────┘
          │               │
          ▼               ▼
┌─────────────────┐ ┌─────────────────┐
│  HTTP Clients   │ │   MCP Clients   │
└─────────────────┘ └─────────────────┘

Adding a New Adapter

  1. Subclass Adapter from toolregistry_server.adapters
  2. Implement run(**kwargs) and create_and_run(cls, route_table, **kwargs)
  3. Optionally implement add_cli_arguments(parser) for CLI integration
  4. Call App().serve(MyAdapter, ...) — no changes to App needed

Deployment Profiles

--profile applies tag-based tool filtering at startup:

Profile Disables
remote FILE_SYSTEM, DESTRUCTIVE, PRIVILEGED tagged tools
local NETWORK tagged tools

Documentation

Contributing

Contributions are welcome! Please see our Contributing Guide for details.

License

MIT — see LICENSE.

Metadata

Release files for toolregistry-server 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for toolregistry-server 0.9.0
File Size Uploaded Provenance Actions
toolregistry_server-0.9.0.tar.gz 389.7 kB With provenance Details for toolregistry_server-0.9.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for toolregistry-server 0.9.0
File Interpreter ABI Platform Actions
toolregistry_server-0.9.0-py3-none-any.whl Python 3 none any Details for toolregistry_server-0.9.0-py3-none-any.whl

Total release size: 666.2 kB

Release files / toolregistry_server-0.9.0.tar.gz

Download URL toolregistry_server-0.9.0.tar.gz
Size 389.7 kB
Tags Source
SHA-256 checksum
How to use checksums
16808690b5dd15e2b6b5f342752f5463ffa666f04f13da3bcb10e203afc3b5d6
BLAKE2b-256 checksum
How to use checksums
31306ce651e634bcf2143078683dacf3a62301d8cb8403765867bdefcd64e58b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Release files / toolregistry_server-0.9.0-py3-none-any.whl

Download URL toolregistry_server-0.9.0-py3-none-any.whl
Size 276.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bfa1cf6d1bfbe76a00d57f04e990d53a0857f6906faf84b17cbaf762a0fadc71
BLAKE2b-256 checksum
How to use checksums
788569ee16fdbd6ab252f1bdbe48f3aef031b18d495f1e3dec19caa8f8135188
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Security for toolregistry-server 0.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for toolregistry_server-0.9.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page