Skip to Content
SDKvibexRegistry

registry

Module: vibex/registry

Agent Market - Template system for agent discovery and instantiation

The Agent Market provides access to pre-configured agent templates from vibex/defaults/agents/ directory. Users can browse, preview, and instantiate these templates into their space.

Classes

AgentMarket

View source

AgentMarket - Manages the agent template marketplace

Methods:

getCategories

View source

Get agent categories from hub configuration

function getCategories(): Promise<MarketCategory[]>

getAllTemplates

View source

Get all available agent templates from .vibex/defaults/agents/ and custom agents from config

function getAllTemplates(): Promise<AgentTemplate[]>

getTemplatesByCategory

View source

Get templates by category

function getTemplatesByCategory(categoryId: string): Promise<AgentTemplate[]>

Parameters:

NameTypeDescription
categoryIdstring

searchTemplates

View source

Search templates by keyword

function searchTemplates(keyword: string): Promise<AgentTemplate[]>

Parameters:

NameTypeDescription
keywordstring

getTemplate

View source

Get a specific template by ID

function getTemplate(templateId: string): Promise<AgentTemplate | null>

Parameters:

NameTypeDescription
templateIdstring

instantiateTemplate

View source

Instantiate a template into a space agent

function instantiateTemplate(templateId: string, customization?: Record<string, any>): Promise<AgentConfig>

Parameters:

NameTypeDescription
templateIdstring- ID of the template to instantiate
customizationRecord<string, any> (optional)- Custom values for template variables

Returns: AgentConfig ready to be used


saveAgentInstance

View source

Save an agent instance to user’s config This creates an instance from a template

function saveAgentInstance(agentConfig: AgentConfig): Promise<void>

Parameters:

NameTypeDescription
agentConfigAgentConfig

getTemplateStats

View source

Get template statistics (for future use)

function getTemplateStats(_templateId: string): Promise<{ downloads: number; rating: number; reviews: number; }>

Parameters:

NameTypeDescription
_templateIdstring

isTemplateInstalled

View source

Check if a template is installed in user’s config

function isTemplateInstalled(templateId: string): Promise<boolean>

Parameters:

NameTypeDescription
templateIdstring

getFeaturedTemplates

View source

Get featured templates (for homepage/dashboard)

function getFeaturedTemplates(limit: number = 6): Promise<AgentTemplate[]>

Parameters:

NameTypeDescription
limitnumber(default: 6)


Interfaces

AgentTemplate

View source

Agent template metadata - extends AgentConfig with market-specific fields

Properties:

NameTypeDescription
categorystring(optional)
tagsstring[](optional)
authorstring(optional)
versionstring(optional)
iconstring(optional)
usageExamplesstring[](optional)
requirementsstring[](optional)
variablesobject(optional)
downloadsnumber(optional)
ratingnumber(optional)
protectedboolean(optional)
isCustomboolean(optional)
createdAtstring(optional)
updatedAtstring(optional)

MarketCategory

View source

Market category definition (from hub/categories.yaml)

Properties:

NameTypeDescription
idstring
namestring
descriptionstring(optional)
iconstring(optional)
ordernumber(optional)