Skip to content

Index

templates

Agent template system — pre-configured agent manifests.

Classes

AgentTemplate dataclass 

AgentTemplate(name: str, description: str = '', system_prompt: str = '', agent_type: str = 'simple', tools: List[str] = list(), max_turns: int = 10, temperature: float = 0.7)

A pre-configured agent manifest loaded from a TOML template.

Functions

discover_templates 

discover_templates(extra_dirs: Optional[List[str | Path]] = None) -> List[AgentTemplate]

Discover and load all agent templates from known directories.

Search order: 1. Built-in templates shipped with the package (templates/data/). 2. User templates at ~/.openjarvis/templates/agents/. 3. Any additional directories supplied via extra_dirs.

Returns a list of :class:AgentTemplate instances sorted by name.

Source code in src/openjarvis/templates/agent_templates.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def discover_templates(
    extra_dirs: Optional[List[str | Path]] = None,
) -> List[AgentTemplate]:
    """Discover and load all agent templates from known directories.

    Search order:
    1. Built-in templates shipped with the package (``templates/data/``).
    2. User templates at ``~/.openjarvis/templates/agents/``.
    3. Any additional directories supplied via *extra_dirs*.

    Returns a list of :class:`AgentTemplate` instances sorted by name.
    """
    dirs: List[Path] = [_builtin_templates_dir(), _user_templates_dir()]
    if extra_dirs:
        dirs.extend(Path(d) for d in extra_dirs)

    seen: Dict[str, AgentTemplate] = {}
    for directory in dirs:
        if not directory.is_dir():
            continue
        for toml_path in sorted(directory.glob("*.toml")):
            tpl = load_template(toml_path)
            # Later directories override earlier ones (user overrides builtin).
            seen[tpl.name] = tpl

    return sorted(seen.values(), key=lambda t: t.name)

load_template 

load_template(path: str | Path) -> AgentTemplate

Load an agent template from a TOML file.

Expected format::

[template]
name = "code-reviewer"
description = "Reviews code for bugs, style, and best practices"

[agent]
type = "native_react"
max_turns = 8
temperature = 0.3
tools = ["file_read", "think"]
system_prompt = """You are a code reviewer..."""

Raises: FileNotFoundError: If path does not exist.

Source code in src/openjarvis/templates/agent_templates.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def load_template(path: str | Path) -> AgentTemplate:
    """Load an agent template from a TOML file.

    Expected format::

        [template]
        name = "code-reviewer"
        description = "Reviews code for bugs, style, and best practices"

        [agent]
        type = "native_react"
        max_turns = 8
        temperature = 0.3
        tools = ["file_read", "think"]
        system_prompt = \"\"\"You are a code reviewer...\"\"\"

    Raises:
        FileNotFoundError: If *path* does not exist.
    """
    path = Path(path)
    if not path.exists():
        raise FileNotFoundError(f"Template file not found: {path}")

    with open(path, "rb") as fh:
        data = tomllib.load(fh)

    template_data: Dict = data.get("template", {})
    agent_data: Dict = data.get("agent", {})

    return AgentTemplate(
        name=template_data.get("name", path.stem),
        description=template_data.get("description", ""),
        system_prompt=agent_data.get("system_prompt", ""),
        agent_type=agent_data.get("type", "simple"),
        tools=agent_data.get("tools", []),
        max_turns=agent_data.get("max_turns", 10),
        temperature=agent_data.get("temperature", 0.7),
    )