ToolRegistry Documentation

Welcome to the official documentation for ToolRegistry, a Python library designed to register, manage, and execute tools (functions) for Agentic AI and large language model applications. This documentation is organized by topic to help you quickly find and learn about different aspects of the library.

Documentation Contents

Here are brief introductions and links to each section:

  • Installation Guide Detailed instructions for installing ToolRegistry, including basic installation and MCP-supported installation.

  • Usage Guide Provides getting started examples and tutorials to help you quickly learn tool registration, invocation, and management.

    • OpenAI Integration Explains how to use ToolRegistry with OpenAI API through function calling.

    • MCP Tool Usage Guides on integrating MCP (Modular Component Protocol) with ToolRegistry to register and call MCP tools.

    • OpenAPI Integration Guides on integrating OpenAPI specifications with ToolRegistry to register and call OpenAPI tools.

    • Hub Tools Collection Provides a collection of utility tools for common llm function calling usage. These tools simplify common tasks and enhance productivity in projects requiring structured tool management.

    • Concurrency Modes Explains thread and process execution modes and their performance characteristics.

    • Examples Demonstrates practical use cases, including consecutive tool call examples.

    • Best Practices Offers principles and recommendations for designing and implementing tools.

  • API References Comprehensive API documentation for all classes and methods in ToolRegistry.

API Changes (starting 0.4.4)

Starting from version 0.4.4, several API methods have been updated for better consistency and usability:

  • ToolRegistry.register_static_tools has been replaced by ToolRegistry.register_from_class.

  • ToolRegistry.register_mcp_tools has been replaced by ToolRegistry.register_from_mcp.

  • ToolRegistry.register_openapi_tools has been replaced by ToolRegistry.register_from_openapi.

The old methods are planned to be deprecated soon, so please migrate to the new interfaces as soon as possible. For backward compatibility, the old names remain as aliases to the new ones.

Overview

ToolRegistry is a powerful Python library that simplifies the registration, management, and execution of tools (functions). Whether you’re building systems integrated with large language models or need structured tool management, ToolRegistry provides a consistent interface supporting both synchronous and asynchronous tool calls.

This documentation details how to install, configure, and use the library in real projects. Browse the sections in the left menu to find the information you need.

Getting Started

Quickly start using ToolRegistry by installing it with this command:

pip install toolregistry

Detailed setup instructions →

License

ToolRegistry is licensed under the MIT License.