ToolRegistry AutoGen Migration

Migrate from ToolRegistry AutoGen methods to AutoGenAdapter for cleaner architecture

python

from praisonaiagents import Agent

agent = Agent(name="migration-agent", instructions="Migrate tools from autogen to the registry.")
agent.start("Migrate my autogen tool definitions to the PraisonAI tool registry.")

AutoGen integration now lives in AutoGenAdapter — the old ToolRegistry autogen methods were removed in PR #2248.

python

from praisonai import PraisonAI

# AutoGenAdapter is wired automatically when framework is autogen-family
praison = PraisonAI(agent_file="agents.yaml", framework="autogen")
praison.run()

The user migrates legacy AutoGen ToolRegistry wiring; new integrations use AutoGenAdapter while removed registry methods are replaced.

Diagram

Quick Start

Migrate from the removed ToolRegistry AutoGen methods to AutoGenAdapter.

Legacy (removed — update required)

python

from praisonai.tool_registry import ToolRegistry

def search_tool(query: str) -> str:
    return f"Found results for: {query}"

registry = ToolRegistry()
registry.register_autogen_adapter("search", search_tool)
adapter = registry.get_autogen_adapter("search")
builtin_tools = registry.list_autogen_adapters()
registry.register_builtin_autogen_adapters()

Recommended (new code)

python

from praisonai.framework_adapters import AutoGenAdapter
from praisonai.tool_registry import ToolRegistry

def search_tool(query: str) -> str:
    return f"Found results for: {query}"

# Use AutoGenAdapter for AutoGen-specific features
adapter = AutoGenAdapter()

# Use ToolRegistry for general tool registration
registry = ToolRegistry()
registry.register_function("search", search_tool)

How It Works

The migration involves moving from ToolRegistry AutoGen methods to the dedicated AutoGenAdapter class.

Diagram

sequenceDiagram
    participant User
    participant ToolRegistry
    participant AutoGenAdapter
    participant AutoGen

    User->>ToolRegistry: register_autogen_adapter() ❌ removed
    Note over User,AutoGen: Do not use — raises AttributeError

    User->>AutoGenAdapter: Use AutoGenAdapter
    AutoGenAdapter->>AutoGen: Direct integration
    AutoGen-->>User: Tool registered

    Note over User,AutoGen: Recommended path for new code

    classDef legacy fill:#F59E0B,stroke:#7C90A0,color:#fff
    classDef new fill:#10B981,stroke:#7C90A0,color:#fff

    class ToolRegistry legacy
    class AutoGenAdapter new

Configuration Options

Both approaches support the same configuration patterns for AutoGen tool integration.

Option	Type	Default	Description
`tool_name`	`str`	Required	Name identifier for the tool
`adapter_function`	`Callable`	Required	Tool implementation function
`registry_instance`	`ToolRegistry`	`None`	Optional registry instance
`builtin_adapters`	`bool`	`False`	Whether to include builtin adapters

What Changed

Method	Status	Replacement
`register_autogen_adapter(tool_type_name, adapter)`	Removed (PR #2248)	Use `AutoGenAdapter` from `praisonai.framework_adapters`
`get_autogen_adapter(tool_type_name)`	Removed (PR #2248)	Use `AutoGenAdapter` from `praisonai.framework_adapters`
`list_autogen_adapters()`	Removed (PR #2248)	Use `AutoGenAdapter` from `praisonai.framework_adapters`
`register_builtin_autogen_adapters()`	Removed (PR #2248)	Use `AutoGenAdapter` from `praisonai.framework_adapters`
`create_autogen_tool_function(tool_class)` and the 17 `autogen_

wrappers on praisonai.inbuilt_tools.autogen_tools | Removed (PR #3583) | No replacement needed — the sole consumer (ToolRegistry.register_builtin_autogen_adapters()) was removed in PR #1590. Use AutoGenAdapter from praisonai.framework_adapters. The module itself remains as a praisonai_tools presence-probe host — retained only for the release from praisonai.inbuilt_tools import * smoke test. It no longer backs PRAISONAI_TOOLS_AVAILABLE` (PR #5318). |

Warning

Wrapper-side cleanup (PR #3583). The wrapper functions on praisonai.inbuilt_tools.autogen_tools — create_autogen_tool_function() and the 17 `autogen_

symbols (autogen_CSVSearchTool, autogen_PDFSearchTool, autogen_RagTool, autogen_ScrapeWebsiteTool, … — see the PR diff for the full list) — have been removed. They were unreachable dead code since PR #1590 removed their only consumer. Code that does from praisonai.inbuilt_tools.autogen_tools import autogen_CSVSearchTool now raises ImportError. Migrate the same way — use AutoGenAdapter from praisonai.framework_adapters`.

The module praisonai.inbuilt_tools.autogen_tools still exists — it now only holds the praisonai_tools presence-probe import, which keeps the release from praisonai.inbuilt_tools import * smoke test working. import praisonai.inbuilt_tools.autogen_tools continues to succeed. As of PR #5318, PRAISONAI_TOOLS_AVAILABLE no longer depends on this probe module — it delegates to praisonai._framework_availability.is_available("praisonai_tools"), the single source of truth. (Before PR #5318 the accessor OR-ed in _get_autogen_tools() is not None, which was always True, so the constant was permanently misleading.)

Common Patterns

Tool Registration

python

# Removed (raises AttributeError)
from praisonai.tool_registry import ToolRegistry

registry = ToolRegistry()
registry.register_autogen_adapter("search", search_tool)  # ❌

# Recommended
from praisonai.framework_adapters import AutoGenAdapter
from praisonai.tool_registry import ToolRegistry

adapter = AutoGenAdapter()
registry = ToolRegistry()
registry.register_function("search", search_tool)

Listing Available Tools

python

# Removed
registry.list_autogen_adapters()  # ❌ AttributeError

# Recommended
from praisonai.framework_adapters import AutoGenAdapter

adapter = AutoGenAdapter()
# Use adapter methods for AutoGen-specific functionality

Builtin Registration

Best Practices

Migrate legacy autogen adapter code

AutoGen adapter methods on ToolRegistry have been removed (PR #2248). Update your code:

python

# Before (broken — raises AttributeError)
from praisonai.tool_registry import ToolRegistry

def web_search(query: str) -> str:
    return f"Search results for: {query}"

registry = ToolRegistry()
registry.register_autogen_adapter("web_search", web_search)  # AttributeError

Use AutoGenAdapter for new projects

For new code, prefer the AutoGenAdapter class for better separation:

python

from praisonai.framework_adapters import AutoGenAdapter
from praisonai.tool_registry import ToolRegistry

def web_search(query: str) -> str:
    return f"Search results for: {query}"

# Recommended approach
adapter = AutoGenAdapter()
registry = ToolRegistry()
registry.register_function("web_search", web_search)
print("Tools registered using recommended pattern")

Migrate incrementally

Replace autogen adapter calls one at a time — each removed method raises AttributeError:

python

from praisonai.tool_registry import ToolRegistry
from praisonai.framework_adapters import AutoGenAdapter

registry = ToolRegistry()
adapter = AutoGenAdapter()

# New tools: register_function
registry.register_function("analyse", analyse_tool)

Verify after migration

Confirm tools resolve through the registry, not removed autogen methods:

python

from praisonai.tool_registry import ToolRegistry

registry = ToolRegistry()
registry.register_function("test", test_tool)
assert registry.get_function("test") is not None

Framework Availability

Framework detection and availability checking

Thread Safety

Thread-safe tool registry operations