Skip to content

Plugins

Plugin DevelopmentLink

Learn how to build and register a standalone invoker script using the Sierra‑SDK plugin system. This guide walks you through defining dependencies, input parameters, result outputs, and the plugin loader function.

Step 1 — Import SierraLink

Python
1
2
import sierra
import requests

Use the core sierra module to access all plugin interfaces, decorators, parameter wrappers, and result constructors.

Step 2 — Define an InvokerScriptLink

Start by creating an InvokerScript object. This acts as the root definition of your plugin logic. And putting in requirements inside invoker.requirement

Python
1
2
3
4
5
6
7
invoker = sierra.InvokerScript(
    name="greet",
    description="Prints a personalized greeting message."
)


invoker.requirement(["requests"])

Step 3 — Register DependenciesLink

You can define helper functions that are not exposed as command-line parameters but are needed by your entry point.

Python
1
2
3
4
5
6
7
@invoker.dependency
def random_function_one(param: int) -> int:
    return param * 2

@invoker.dependency
def random_function_two(message: str) -> str:
    return message.upper()

Step 4 — Define the Entry PointLink

Mark the main function using @invoker.entry_point. Input arguments should use sierra.Param and sierra.SierraOption.

Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
@invoker.entry_point
def run(
    name: sierra.Param[
        str | None,
        sierra.SierraOption(description="Name of the person to greet.", mandatory="MANDATORY")
    ],
    polite: sierra.Param[
        bool | None,
        sierra.SierraOption(description="Include polite greeting?", mandatory=None)
    ] = False
) -> None:
    if name is None:
        result = sierra.create_error_result("Missing mandatory parameter: name")
    else:
        greeting = f"Hello, {name}!"
        if polite:
            greeting = f"Good day to you, {name}!"
        result = sierra.create_tree_result([greeting])
    print(result)

Step 5 — Load the PluginLink

The plugin must define a load() function. This hook is invoked by the Sierra plugin loader to register your invoker.

Python
1
2
def load(client: sierra.SierraDevelopmentClient) -> None:
    client.load_invoker(invoker)

SummaryLink

Component Purpose
InvokerScript() Defines a new plugin/invoker
@invoker.dependency Adds a helper function to the script
@invoker.entry_point Marks the main callable
sierra.Param[...] Wraps a parameter with typing and options metadata
load() Registers the invoker into the plugin system
create_tree_result() Generates structured tree output
create_error_result() Returns a formatted error

Once created, this invoker becomes discoverable by Sierra CLI or GUI runners.