Skip to main content

SkillSpec

Agent Runtimes

Agent Runtimes / types/skills / SkillSpec

Interface: SkillSpec

Defined in: src/types/skills.ts:86

Specification for a skill.

Supports three variants:

  • Variant 1 (name-based): Uses module to discover and load a skill from a Python module path (e.g. agent_skills.events).
  • Variant 2 (package-based): Uses package and method to reference a callable in an installable Python package. Attributes such as license, compatibility, allowedTools, and skillMetadata are discovered at runtime from the SKILL.md packaged inside the Python package — they should NOT be duplicated in the YAML spec.
  • Variant 3 (path-based): Uses path to load a local skill directory containing SKILL.md (relative to the configured skills folder).

Properties​

allowedTools?​

optional allowedTools?: string[]

Defined in: src/types/skills.ts:108

Pre-approved tools the skill may use (agentskills.io spec)

compatibility?​

optional compatibility?: string

Defined in: src/types/skills.ts:106

Environment requirements (agentskills.io spec)

dependencies?​

optional dependencies?: string[]

Defined in: src/types/skills.ts:116

Python package dependencies

description​

description: string

Defined in: src/types/skills.ts:94

Skill description

emoji?​

optional emoji?: string

Defined in: src/types/skills.ts:122

Emoji identifier

enabled​

enabled: boolean

Defined in: src/types/skills.ts:124

Whether the skill is enabled

icon?​

optional icon?: string

Defined in: src/types/skills.ts:120

Icon identifier

id​

id: string

Defined in: src/types/skills.ts:88

Unique skill identifier

license?​

optional license?: string

Defined in: src/types/skills.ts:104

License name or reference (agentskills.io spec)

method?​

optional method?: string

Defined in: src/types/skills.ts:100

Callable/function name in the package (variant 2)

module?​

optional module?: string

Defined in: src/types/skills.ts:96

Python module path for name-based discovery (variant 1)

name​

name: string

Defined in: src/types/skills.ts:92

Display name for the skill

optionalEnvVars?​

optional optionalEnvVars?: string[]

Defined in: src/types/skills.ts:114

Optional environment variables

package?​

optional package?: string

Defined in: src/types/skills.ts:98

Python package containing the skill implementation (variant 2)

path?​

optional path?: string

Defined in: src/types/skills.ts:102

Path to a local skill directory or SKILL.md file (variant 3)

requiredEnvVars​

requiredEnvVars: string[]

Defined in: src/types/skills.ts:112

Environment variables required by this skill

skillMetadata?​

optional skillMetadata?: Record<string, string>

Defined in: src/types/skills.ts:110

Arbitrary key-value metadata (agentskills.io spec)

tags​

tags: string[]

Defined in: src/types/skills.ts:118

Tags for categorization

version​

version: string

Defined in: src/types/skills.ts:90

Skill version