API References

Welcome to the API references for the project. Below is a list of available modules:

• toolregistry package
  • ToolRegistry
    • ToolRegistry._tools
    • ToolRegistry.register()
    • ToolRegistry.merge()
    • ToolRegistry.register_mcp_tools()
    • ToolRegistry.register_mcp_tools_async()
    • ToolRegistry.register_openapi_tools()
    • ToolRegistry.register_openapi_tools_async()
    • ToolRegistry.get_available_tools()
    • ToolRegistry.get_tools_json()
    • ToolRegistry.get_tool()
    • ToolRegistry.get_callable()
    • ToolRegistry.execute_tool_calls()
    • ToolRegistry.recover_tool_call_assistant_message()
  • Tool
    • Tool.name
    • Tool.description
    • Tool.parameters
    • Tool.callable
    • Tool.is_async
    • Tool.parameters_model
    • Tool.from_function()
    • Tool.model_config
    • Tool.get_json_schema()
    • Tool.describe()
    • Tool.run()
    • Tool.arun()
  • Submodules
    • toolregistry.mcp_integration module
      • MCPToolWrapper
        • MCPToolWrapper.url
        • MCPToolWrapper.name
        • MCPToolWrapper.params
        • MCPToolWrapper.call_sync()
        • MCPToolWrapper.call_async()
      • MCPTool
        • MCPTool.name
        • MCPTool.description
        • MCPTool.parameters
        • MCPTool.callable
        • MCPTool.is_async
        • MCPTool.from_tool_json()
        • MCPTool.model_config
      • MCPIntegration
        • MCPIntegration.registry
        • MCPIntegration.register_mcp_tools_async()
        • MCPIntegration.register_mcp_tools()
    • toolregistry.openapi_integration module
      • check_common_endpoints()
      • parse_openapi_spec_from_url()
      • get_openapi_spec()
      • OpenAPIToolWrapper
        • OpenAPIToolWrapper.base_url
        • OpenAPIToolWrapper.name
        • OpenAPIToolWrapper.method
        • OpenAPIToolWrapper.path
        • OpenAPIToolWrapper.params
        • OpenAPIToolWrapper.call_sync()
        • OpenAPIToolWrapper.call_async()
      • OpenAPITool
        • OpenAPITool.from_openapi_spec()
        • OpenAPITool.model_config
      • OpenAPIIntegration
        • OpenAPIIntegration.registry
        • OpenAPIIntegration.register_openapi_tools_async()
        • OpenAPIIntegration.register_openapi_tools()
    • toolregistry.parameter_models module
      • InvalidSignature
        • InvalidSignature.message
      • ArgModelBase
        • ArgModelBase.model_config
        • ArgModelBase.model_dump_one_level()
        • ArgModelBase.model_config
    • toolregistry.tool module
      • Tool
        • Tool.name
        • Tool.description
        • Tool.parameters
        • Tool.callable
        • Tool.is_async
        • Tool.parameters_model
        • Tool.from_function()
        • Tool.model_config
        • Tool.get_json_schema()
        • Tool.describe()
        • Tool.run()
        • Tool.arun()
    • toolregistry.tool_registry module
      • ToolRegistry
        • ToolRegistry._tools
        • ToolRegistry.register()
        • ToolRegistry.merge()
        • ToolRegistry.register_mcp_tools()
        • ToolRegistry.register_mcp_tools_async()
        • ToolRegistry.register_openapi_tools()
        • ToolRegistry.register_openapi_tools_async()
        • ToolRegistry.get_available_tools()
        • ToolRegistry.get_tools_json()
        • ToolRegistry.get_tool()
        • ToolRegistry.get_callable()
        • ToolRegistry.execute_tool_calls()
        • ToolRegistry.recover_tool_call_assistant_message()