models

Documentation

Index

• type AgentJSON
• type AgentListResponse
• type AgentManifest
• type AgentMetadata
• type AgentPackageInfo
• type AgentRegistryExtensions
• type AgentResponse
• type AgentResponseMeta
• type AgentSemanticMeta
• type Deployment
• type DeploymentFilter
• type McpServerType
• type ServerListResponse
• type ServerMetadata
• type ServerResponse
• type ServerResponseMeta
• type ServerSemanticMeta
• type SkillJSON
• type SkillListResponse
• type SkillMetadata
• type SkillPackageInfo
• type SkillRegistryExtensions
• type SkillRemoteInfo
• type SkillRepository
• type SkillResponse
• type SkillResponseMeta

Types

type AgentJSON

type AgentJSON struct {
	AgentManifest `json:",inline"`
	Title         string             `json:"title,omitempty"`
	Version       string             `json:"version"`
	Status        string             `json:"status,omitempty"`
	WebsiteURL    string             `json:"websiteUrl,omitempty"`
	Repository    *model.Repository  `json:"repository,omitempty" doc:"Optional repository metadata for the agent source code."`
	Packages      []AgentPackageInfo `json:"packages,omitempty"`
	Remotes       []model.Transport  `json:"remotes,omitempty"`
}

AgentJSON mirrors the ServerJSON shape for now, defined locally

type AgentListResponse

type AgentListResponse struct {
	Agents   []AgentResponse `json:"agents"`
	Metadata AgentMetadata   `json:"metadata"`
}

type AgentManifest

type AgentManifest struct {
	Name              string          `yaml:"agentName" json:"name"`
	Image             string          `yaml:"image" json:"image"`
	Language          string          `yaml:"language" json:"language"`
	Framework         string          `yaml:"framework" json:"framework"`
	ModelProvider     string          `yaml:"modelProvider" json:"modelProvider"`
	ModelName         string          `yaml:"modelName" json:"modelName"`
	Description       string          `yaml:"description" json:"description"`
	Version           string          `yaml:"version,omitempty" json:"version,omitempty"`
	TelemetryEndpoint string          `yaml:"telemetryEndpoint,omitempty" json:"telemetryEndpoint,omitempty"`
	McpServers        []McpServerType `yaml:"mcpServers,omitempty" json:"mcpServers,omitempty"`
	UpdatedAt         time.Time       `yaml:"updatedAt,omitempty" json:"updatedAt,omitempty"`
}

AgentManifest represents the agent project configuration and metadata.

type AgentMetadata

type AgentMetadata struct {
	NextCursor string `json:"nextCursor,omitempty"`
	Count      int    `json:"count"`
}

type AgentPackageInfo

type AgentPackageInfo struct {
	RegistryType string `json:"registryType"`
	Identifier   string `json:"identifier"`
	Version      string `json:"version"`
	Transport    struct {
		Type string `json:"type"`
	} `json:"transport"`
}

type AgentRegistryExtensions

type AgentRegistryExtensions struct {
	Status      string    `json:"status"`
	PublishedAt time.Time `json:"publishedAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
	IsLatest    bool      `json:"isLatest"`
	Published   bool      `json:"published"`
}

AgentRegistryExtensions mirrors official metadata stored separately

type AgentResponse

type AgentResponse struct {
	Agent AgentJSON         `json:"agent"`
	Meta  AgentResponseMeta `json:"_meta"`
}

type AgentResponseMeta

type AgentResponseMeta struct {
	Official *AgentRegistryExtensions `json:"io.modelcontextprotocol.registry/official,omitempty"`
	Semantic *AgentSemanticMeta       `json:"aregistry.ai/semantic,omitempty"`
}

type AgentSemanticMeta

type AgentSemanticMeta struct {
	Score float64 `json:"score"`
}

type Deployment

type Deployment struct {
	ServerName   string            `json:"serverName"`
	Version      string            `json:"version"`
	DeployedAt   time.Time         `json:"deployedAt"`
	UpdatedAt    time.Time         `json:"updatedAt"`
	Status       string            `json:"status"`
	Config       map[string]string `json:"config"`
	PreferRemote bool              `json:"preferRemote"`
	ResourceType string            `json:"resourceType"` // "mcp" or "agent"
	Runtime      string            `json:"runtime"`      // "local" or "kubernetes"
	IsExternal   bool              `json:"isExternal"`   // true if not managed by registry
}

Deployment represents a deployed server with its configuration

type DeploymentFilter

type DeploymentFilter struct {
	Runtime      *string // "local" or "kubernetes"
	ResourceType *string // "mcp" or "agent"
}

DeploymentFilter defines filtering options for deployment queries

type McpServerType

type McpServerType struct {
	// MCP Server Type -- remote, command, registry
	Type    string            `yaml:"type" json:"type"`
	Name    string            `yaml:"name" json:"name"`
	Image   string            `yaml:"image,omitempty" json:"image,omitempty"`
	Build   string            `yaml:"build,omitempty" json:"build,omitempty"`
	Command string            `yaml:"command,omitempty" json:"command,omitempty"`
	Args    []string          `yaml:"args,omitempty" json:"args,omitempty"`
	Env     []string          `yaml:"env,omitempty" json:"env,omitempty"`
	URL     string            `yaml:"url,omitempty" json:"url,omitempty"`
	Headers map[string]string `yaml:"headers,omitempty" json:"headers,omitempty"`
	// Registry MCP server fields -- these are translated into the appropriate fields above when the agent is ran or deployed
	RegistryURL                string `yaml:"registryURL,omitempty" json:"registryURL,omitempty"`
	RegistryServerName         string `yaml:"registryServerName,omitempty" json:"registryServerName,omitempty"`
	RegistryServerVersion      string `yaml:"registryServerVersion,omitempty" json:"registryServerVersion,omitempty"`
	RegistryServerPreferRemote bool   `yaml:"registryServerPreferRemote,omitempty" json:"registryServerPreferRemote,omitempty"`
}

McpServerType represents a single MCP server configuration.

type ServerListResponse

type ServerListResponse struct {
	Servers  []ServerResponse `json:"servers"`
	Metadata ServerMetadata   `json:"metadata"`
}

ServerListResponse wraps a list response.

type ServerMetadata

type ServerMetadata struct {
	NextCursor string `json:"nextCursor,omitempty"`
	Count      int    `json:"count"`
}

ServerMetadata holds pagination info for server listings.

type ServerResponse

type ServerResponse struct {
	Server apiv0.ServerJSON   `json:"server"`
	Meta   ServerResponseMeta `json:"_meta"`
}

ServerResponse is the server API shape with registry-managed metadata.

type ServerResponseMeta

type ServerResponseMeta struct {
	Official *apiv0.RegistryExtensions `json:"io.modelcontextprotocol.registry/official,omitempty"`
	Semantic *ServerSemanticMeta       `json:"aregistry.ai/semantic,omitempty"`
}

ServerResponseMeta mirrors the MCP ResponseMeta but adds semantic metadata.

type ServerSemanticMeta

type ServerSemanticMeta struct {
	Score float64 `json:"score"`
}

ServerSemanticMeta carries semantic search metadata for servers.

type SkillJSON

type SkillJSON struct {
	Name        string             `json:"name"`
	Title       string             `json:"title,omitempty"`
	Category    string             `json:"category,omitempty"`
	Description string             `json:"description"`
	Version     string             `json:"version"`
	Status      string             `json:"status,omitempty"`
	WebsiteURL  string             `json:"websiteUrl,omitempty"`
	Repository  *SkillRepository   `json:"repository,omitempty"`
	Packages    []SkillPackageInfo `json:"packages,omitempty"`
	Remotes     []SkillRemoteInfo  `json:"remotes,omitempty"`
}

SkillJSON mirrors the ServerJSON shape for now, defined locally

type SkillListResponse

type SkillListResponse struct {
	Skills   []SkillResponse `json:"skills"`
	Metadata SkillMetadata   `json:"metadata"`
}

type SkillMetadata

type SkillMetadata struct {
	NextCursor string `json:"nextCursor,omitempty"`
	Count      int    `json:"count"`
}

type SkillPackageInfo

type SkillPackageInfo struct {
	RegistryType string `json:"registryType"`
	Identifier   string `json:"identifier"`
	Version      string `json:"version"`
	Transport    struct {
		Type string `json:"type"`
	} `json:"transport"`
}

type SkillRegistryExtensions

type SkillRegistryExtensions struct {
	Status      string    `json:"status"`
	PublishedAt time.Time `json:"publishedAt"`
	UpdatedAt   time.Time `json:"updatedAt"`
	IsLatest    bool      `json:"isLatest"`
	Published   bool      `json:"published"`
}

RegistryExtensions mirrors official metadata stored separately

type SkillRemoteInfo

type SkillRemoteInfo struct {
	URL string `json:"url"`
}

type SkillRepository

type SkillRepository struct {
	URL    string `json:"url"`
	Source string `json:"source"`
}

type SkillResponse

type SkillResponse struct {
	Skill SkillJSON         `json:"skill"`
	Meta  SkillResponseMeta `json:"_meta"`
}

type SkillResponseMeta

type SkillResponseMeta struct {
	Official *SkillRegistryExtensions `json:"io.modelcontextprotocol.registry/official,omitempty"`
}