google-adk-kotlin-core/com.google.adk.kt.skills/Frontmatter

Frontmatter

data class Frontmatter(val name: String, val description: String, val license: String? = null, val compatibility: String? = null, val allowedTools: String? = null, val metadata: Map<String, Any?> = emptyMap())

Represents the frontmatter of a skill, containing metadata about the skill.

Validation is enforced at construction time: any attempt to instantiate a Frontmatter with fields that violate the specification (e.g. invalid name characters, oversized description) will fail with IllegalArgumentException. As a result, every Frontmatter instance is guaranteed to be well-formed.

Throws

IllegalArgumentException

if any field violates the frontmatter specification.

Constructors

Frontmatter

constructor(name: String, description: String, license: String? = null, compatibility: String? = null, allowedTools: String? = null, metadata: Map<String, Any?> = emptyMap())

Types

Builder

class Builder

Fluent builder for Frontmatter, provided primarily for Java callers. Any property left unset falls back to the same default as the constructor.

Companion

object Companion

Properties

allowedTools

val allowedTools: String?

The tools that are allowed to be used by the skill.

compatibility

val compatibility: String?

The compatibility of the skill.

description

val description: String

A description of the skill.

license

val license: String?

The license of the skill.

metadata

val metadata: Map<String, Any?>

Additional metadata about the skill.

name

val name: String

The name of the skill.

Functions

toBuilder

fun toBuilder(): Frontmatter.Builder

Returns a Builder initialized with this instance's properties, primarily for Java callers. Prefer it over copy from Java: copy takes every property positionally, so its signature changes whenever a property is added.