Skip to content

vox-skills API Reference (generated)

Crate: vox-skills · Version: 0.6.0 · Target: Library (lib.rs)

Skill marketplace and plugin architecture for the Vox agent system

vox-skills — Skill Marketplace and Plugin Architecture

Section titled “vox-skills — Skill Marketplace and Plugin Architecture”

Provides a typed skill registry, skill bundle format parsing, plugin lifecycle management, and an optional Vox Skills HTTP bridge.

Submodules carry detailed docs; the crate root re-exports stable types for embedders.

FeatureDefault / Enables
default—
skills-registry—
DependencyKind
vox-containerNormal
vox-http-clientNormal
vox-openclaw-runtimeNormal
vox-packageNormal
vox-plugin-hostNormal
vox-skill-runtimeNormal
vox-dbDevelopment
ModuleDescription
builtins—
bundleIn-memory skill bundle (VoxSkillBundle) and JSON (de)serialization.
hooksLifecycle hook registry and event types.
manifestSkill manifest schema (SkillManifest, categories, permissions).
parserParse SKILL.md (YAML/TOML front matter + body) into a bundle.
pluginPlugin trait, skill-backed plugins, and PluginManager.
providerShared Arc<SkillRegistry> factory for MCP and CLI surfaces.
registryInstall, uninstall, search, and list skills (SkillRegistry).
registry_apiHTTP client for the remote skills marketplace (skills-registry feature).
sandboxUnified container sandbox for community skill execution. Uses vox-container’s Docker/Podman backend — the same infrastructure used for .vox application deployment — to sandbox untrusted skills.
EnumDescription
SkillErrorErrors from the skill system.
ConstantDescription
SKILLS_REGISTRY_BASEThe canonical Vox Skills marketplace registry URL.
Dependency Topology, diagram 115 nodes, 14 edges: vox-skills → vox-container; vox-skills → vox-db; vox-skills → vox-http-client; vox-skills → vox-openclaw-runtime; vox-skills → vox-package; vox-skills → vox-plugin-host; vox-skills → vox-skill-runtime; vox-actor-runtime → vox-skills; vox-cli → vox-skills; vox-cli-research → vox-…vox-skillsvox-containervox-dbvox-http-clientvox-openclaw-runtimevox-packagevox-plugin-hostvox-skill-runtimevox-actor-runtimevox-clivox-cli-researchvox-integration-testsvox-orchestratorvox-orchestrator-dvox-orchestrator-mcp
Diagram source
graph {
direction: right
node vox_skills: "vox-skills"
node vox_container: "vox-container"
vox_skills -> vox_container
node vox_db: "vox-db"
vox_skills -> vox_db
node vox_http_client: "vox-http-client"
vox_skills -> vox_http_client
node vox_openclaw_runtime: "vox-openclaw-runtime"
vox_skills -> vox_openclaw_runtime
node vox_package: "vox-package"
vox_skills -> vox_package
node vox_plugin_host: "vox-plugin-host"
vox_skills -> vox_plugin_host
node vox_skill_runtime: "vox-skill-runtime"
vox_skills -> vox_skill_runtime
node vox_actor_runtime: "vox-actor-runtime"
vox_actor_runtime -> vox_skills
node vox_cli: "vox-cli"
vox_cli -> vox_skills
node vox_cli_research: "vox-cli-research"
vox_cli_research -> vox_skills
node vox_integration_tests: "vox-integration-tests"
vox_integration_tests -> vox_skills
node vox_orchestrator: "vox-orchestrator"
vox_orchestrator -> vox_skills
node vox_orchestrator_d: "vox-orchestrator-d"
vox_orchestrator_d -> vox_skills
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_skills
}
Consumer CrateRole
vox-actor-runtimeDirect workspace dependent
vox-cliDirect workspace dependent
vox-cli-researchDirect workspace dependent
vox-integration-testsDirect workspace dependent
vox-orchestratorDirect workspace dependent
vox-orchestrator-dDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
KindSymbolSignatureSourceDescription
enumSkillErrorpub enum SkillErrorcrates/vox-skills/src/lib.rs#L49-L85Errors from the skill system.
fnbuiltins::install_builtinspub async fn install_builtins(_registry: &SkillRegistry) -> Result<usize, SkillError>crates/vox-skills/src/builtins.rs#L14-L16Install all built-in skills into the registry if they are not already present. This is now a no-op (returns 0). Skills are discovered and installed from the plugin data directory by the orchestrator bridge at startup.
enumhooks::HookEventpub enum HookEventcrates/vox-skills/src/hooks.rs#L12-L23Events the hook system fires.
typehooks::HookFnpub type HookFn = Box<dyn Fn(&str) -> Result<Option<String>, SkillError> + Send + Sync>crates/vox-skills/src/hooks.rs#L35A hook function: takes context JSON string, returns optional output JSON.
structhooks::HookRegistrypub struct HookRegistrycrates/vox-skills/src/hooks.rs#L38-L40Registry of named hook functions keyed by event.
fnhooks::newpub fn new() -> Selfcrates/vox-skills/src/hooks.rs#L43-L47—
fnhooks::registerpub fn register(&self, event: HookEvent, hook_id: impl Into<String>, f: HookFn)crates/vox-skills/src/hooks.rs#L50-L55Register a hook for an event with an ID (for later removal).
fnhooks::deregisterpub fn deregister(&self, event: &HookEvent, hook_id: &str) -> boolcrates/vox-skills/src/hooks.rs#L58-L67Deregister a hook by event + ID.
fnhooks::firepub fn fire(&self, event: &HookEvent, context_json: &str) -> Vec<String>crates/vox-skills/src/hooks.rs#L70-L85Fire all hooks for an event, passing context JSON.
fnhooks::countpub fn count(&self, event: &HookEvent) -> usizecrates/vox-skills/src/hooks.rs#L87-L91—
enumplugin::PluginKindpub enum PluginKindcrates/vox-skills/src/plugin.rs#L18-L27Plugin kind discriminant.
structplugin::PluginMetapub struct PluginMetacrates/vox-skills/src/plugin.rs#L31-L37Metadata about a loaded plugin.
traitplugin::Pluginpub trait Plugin: Send + Synccrates/vox-skills/src/plugin.rs#L40-L51Plugin lifecycle trait.
structplugin::SkillPluginpub struct SkillPlugincrates/vox-skills/src/plugin.rs#L54-L57A skill-backed plugin implementation.
fnplugin::newpub fn new(crates/vox-skills/src/plugin.rs#L60—
structplugin::PluginManagerpub struct PluginManagercrates/vox-skills/src/plugin.rs#L94-L96Manager for all loaded plugins.
fnplugin::newpub fn new() -> Selfcrates/vox-skills/src/plugin.rs#L99-L103—
fnplugin::loadpub fn load(&self, plugin: Box<dyn Plugin>) -> Result<(), SkillError>crates/vox-skills/src/plugin.rs#L106-L115Load a plugin into the manager.
fnplugin::unloadpub fn unload(&self, id: &str) -> Result<(), SkillError>crates/vox-skills/src/plugin.rs#L118-L127Unload a plugin by ID.
fnplugin::listpub fn list(&self) -> Vec<PluginMeta>crates/vox-skills/src/plugin.rs#L130-L133List all loaded plugin metadata.
fnplugin::is_loadedpub fn is_loaded(&self, id: &str) -> boolcrates/vox-skills/src/plugin.rs#L136-L139Check if a plugin is loaded by ID.
fnplugin::all_tool_idspub fn all_tool_ids(&self) -> Vec<String>crates/vox-skills/src/plugin.rs#L142-L145Get all tool IDs provided by all loaded plugins.
structregistry_api::SkillsRegistryResultpub struct SkillsRegistryResultcrates/vox-skills/src/registry_api.rs#L13-L21A search result from the Vox Skills registry.
structregistry_api::SkillsRegistryClientpub struct SkillsRegistryClientcrates/vox-skills/src/registry_api.rs#L24-L28HTTP client for the Vox Skills marketplace.
fnregistry_api::newpub fn new() -> Selfcrates/vox-skills/src/registry_api.rs#L32-L34Create a client pointing at the official Vox Skills registry.
fnregistry_api::with_basepub fn with_base(base_url: impl Into<String>) -> Selfcrates/vox-skills/src/registry_api.rs#L37-L43Create a client pointing at a custom registry URL.
fnregistry_api::with_api_keypub fn with_api_key(mut self, key: impl Into<String>) -> Selfcrates/vox-skills/src/registry_api.rs#L45-L48—
fnregistry_api::searchpub async fn search(&self, query: &str) -> Result<Vec<SkillsRegistryResult>, SkillError>crates/vox-skills/src/registry_api.rs#L51-L67Search the registry for skills matching a keyword.
fnregistry_api::downloadpub async fn download(crates/vox-skills/src/registry_api.rs#L70Download a skill bundle by ID and optional version.
fnregistry_api::publishpub async fn publish(&self, bundle: &VoxSkillBundle) -> Result<(), SkillError>crates/vox-skills/src/registry_api.rs#L99-L124Publish a skill bundle to the registry.
fnregistry_api::get_manifestpub async fn get_manifest(&self, id: &str) -> Result<SkillManifest, SkillError>crates/vox-skills/src/registry_api.rs#L127-L141Get metadata for a specific skill.