agent

agent

Agent

backend instance-attribute

backend: SkipValidation[AgentBackend]

capabilities class-attribute instance-attribute

capabilities: list[object] = Field(default_factory=list)

env class-attribute instance-attribute

env: dict[str, str] = Field(default_factory=dict)

instructions class-attribute instance-attribute

instructions: str | None = None

mcp_servers class-attribute instance-attribute

mcp_servers: list[MCPServer] = Field(default_factory=list)

metadata class-attribute instance-attribute

metadata: dict[str, str] = Field(default_factory=dict)

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

name instance-attribute

name: str

permission class-attribute instance-attribute

permission: PermissionPolicy | None = None

skills class-attribute instance-attribute

skills: list[Skill] = Field(default_factory=list)

strict class-attribute instance-attribute

strict: bool = True

AgentBackend

id instance-attribute

id: str

command

command(
    prompt: str, run_config: Any | None = None
) -> list[str]

Return command to execute inside sandbox.

materialise

materialise(
    ctx: MaterialiseContext, agent: AgentLike
) -> None

Write backend-specific config into the workspace.

MCPServer

disabled_tools class-attribute instance-attribute

disabled_tools: list[str] = Field(default_factory=list)

enabled class-attribute instance-attribute

enabled: bool = True

enabled_tools class-attribute instance-attribute

enabled_tools: list[str] = Field(default_factory=list)

name instance-attribute

name: str

required class-attribute instance-attribute

required: bool = False

startup_timeout_sec class-attribute instance-attribute

startup_timeout_sec: int | None = None

tool_timeout_sec class-attribute instance-attribute

tool_timeout_sec: int | None = None

type instance-attribute

type: str

PermissionPolicy

default class-attribute instance-attribute

default: PermissionAction | None = None

tools class-attribute instance-attribute

tools: dict[str, PermissionRule] = Field(
    default_factory=dict
)

to_opencode

to_opencode() -> (
    PermissionAction | dict[str, PermissionRule]
)

Skill

assets class-attribute instance-attribute

assets: list[Path] = Field(default_factory=list)

compatibility class-attribute instance-attribute

compatibility: str | None = None

description class-attribute instance-attribute

description: str = ''

instructions instance-attribute

instructions: str

license class-attribute instance-attribute

license: str | None = None

metadata class-attribute instance-attribute

metadata: dict[str, Any] = Field(default_factory=dict)

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

name instance-attribute

name: str

path class-attribute instance-attribute

path: Path | None = None

from_dir classmethod

from_dir(path: str | Path) -> Skill

to_skill_md

to_skill_md(*, frontmatter: bool = False) -> str

validate_opencode_name

validate_opencode_name() -> None