ToolRegistry: A Protocol-Agnostic Tool Management Library for OpenAI-Compatible LLM Applications#
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.
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
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.
Basic Usage Guide Provides getting started examples and tutorials to help you quickly learn tool registration, invocation, and management.
Function calling via OpenAI Compatible API Explains how to use ToolRegistry with OpenAI compatible API through function calling.
Register Tools from Various Sources
Concurrency Modes Explains thread and process execution modes and their performance characteristics.
Best Practices on Tool Implementation Offers principles and recommendations for designing and implementing tools.
Examples Demonstrates practical use cases, including consecutive tool call examples.
API References Comprehensive API documentation for all classes and methods in ToolRegistry.
Note
As of version 0.4.12, the previously deprecated methods ToolRegistry.register_static_tools
, ToolRegistry.register_mcp_tools
, and ToolRegistry.register_openapi_tools
have been REMOVED. Users must update their implementations to use the new methods: ToolRegistry.register_from_class
, ToolRegistry.register_from_mcp
, and ToolRegistry.register_from_openapi
. Please ensure your codebase is compatible with this update for uninterrupted functionality.
Citation#
If you use ToolRegistry in your research or project, please consider cite it as:
@software{toolregistry2025,
title={ToolRegistry: A Protocol-Agnostic Tool Management Library for OpenAI-Compatible LLM Applications},
author={Peng Ding},
year={2025},
url={https://github.com/Oaklight/ToolRegistry},
note={A Python library for unified tool registration, execution, and management across multiple protocols in OpenAI-compatible LLM applications}
}
License#
ToolRegistry is licensed under the MIT License.