OpenAkita Plugin SDK

Build plugins for OpenAkita without installing the full runtime.

Install

pip install openakita-plugin-sdk

For development from source:

pip install -e ./openakita-plugin-sdk

30-Second Quick Start

Option A: Scaffold a plugin (recommended)

python -m openakita_plugin_sdk.scaffold --id my-tool --type tool --dir ./plugins

This creates a complete plugin directory with plugin.json, plugin.py, and README.md.

Available types: tool, channel, rag, memory, llm, hook, skill, mcp, ui.

Option B: Use decorators

from openakita_plugin_sdk import PluginBase, PluginAPI
from openakita_plugin_sdk.decorators import tool, hook, auto_register

@tool(name="greet", description="Greet someone by name")
async def greet(tool_name: str, arguments: dict) -> str:
    return f"Hello, {arguments['name']}!"

@hook("on_message_received")
async def log_msg(**kwargs):
    print(f"Got: {kwargs.get('text', '')[:50]}")

class Plugin(PluginBase):
    def on_load(self, api: PluginAPI) -> None:
        auto_register(api)

Option C: Manual registration

from openakita_plugin_sdk import PluginBase, PluginAPI
from openakita_plugin_sdk.tools import tool_definition

TOOLS = [
    tool_definition(
        name="hello",
        description="Say hello",
        parameters={
            "type": "object",
            "properties": {"name": {"type": "string"}},
            "required": ["name"],
        },
    ),
]

class Plugin(PluginBase):
    def on_load(self, api: PluginAPI) -> None:
        async def handler(tool_name: str, arguments: dict) -> str:
            return f"Hello, {arguments['name']}!"

        api.register_tools(TOOLS, handler)

Plugin Types at a Glance

Testing

from openakita_plugin_sdk.testing import MockPluginAPI, assert_plugin_loads

def test_my_plugin():
    plugin = Plugin()
    api = assert_plugin_loads(plugin)
    assert "greet" in api.registered_tools

Documentation

SDK Modules

from openakita_plugin_sdk import (
    PluginBase, PluginAPI, PluginManifest, tool_definition,
    SDK_VERSION, PLUGIN_API_VERSION, PLUGIN_UI_API_VERSION,
)
from openakita_plugin_sdk.decorators import tool, hook, auto_register
from openakita_plugin_sdk.scaffold import scaffold_plugin
from openakita_plugin_sdk.testing import MockPluginAPI, assert_plugin_loads
from openakita_plugin_sdk.hooks import HOOK_NAMES, HOOK_SIGNATURES
from openakita_plugin_sdk.channel import ChannelAdapter, ChannelPluginMixin
from openakita_plugin_sdk.llm import (
    LLMCompletion, LLMModel, LLMProvider, LLMSelectionPolicy,
    PluginLLM, ProviderRegistry,
)
from openakita_plugin_sdk.protocols import MemoryBackendProtocol, RetrievalSource, SearchBackend
from openakita_plugin_sdk.config import config_schema, config_property
from openakita_plugin_sdk.types import UnifiedMessage, OutgoingMessage, ToolCall