API Reference¶

Full API documentation is available on pkg.go.dev:

Quick Reference¶

skill Package¶

// Core interfaces
type Skill interface {
    Name() string
    Description() string
    Tools() []Tool
    Init(ctx context.Context) error
    Close() error
}

type Tool interface {
    Name() string
    Description() string
    Parameters() map[string]Parameter
    Call(ctx context.Context, params map[string]any) (any, error)
}

// Parameter definition
type Parameter struct {
    Type        string
    Description string
    Required    bool
    Enum        []any
    Default     any
    Items       *Parameter
    Properties  map[string]Parameter
}

// Convenience types
type BaseSkill struct { ... }
func NewTool(name, description string, params map[string]Parameter, handler ToolFunc) *FuncTool

// CommandTool wraps CLI commands as tools
type CommandTool struct {
    ToolName        string
    ToolDescription string
    Command         string
    Args            []string            // Use {{param}} for substitution
    ToolParameters  map[string]Parameter
    WorkingDir      string
    Timeout         time.Duration
    Env             []string
}
func NewCommandTool(name, desc, command string, args []string, params map[string]Parameter) *CommandTool

type CommandResult struct {
    Stdout   string
    Stderr   string
    ExitCode int
}

loader Package¶

// Load SKILL.md files
func LoadMarkdownSkill(path string) (*MarkdownSkill, error)
func LoadMarkdownSkillDir(dir string) (*MarkdownSkill, error)
func ParseMarkdownSkill(content, sourcePath string) (*MarkdownSkill, error)

// Discover skills
func DiscoverSkills(root string) ([]*SkillInfo, error)
func Inspect(dir string) (*SkillInfo, error)

// MarkdownSkill implements skill.Skill
type MarkdownSkill struct { ... }
func (s *MarkdownSkill) GetGuidance() string
func (s *MarkdownSkill) GetInstallSteps() []InstallStep

// Unified loading with Go preference
type UnifiedLoader struct { ... }
func NewUnifiedLoader() *UnifiedLoader
func (l *UnifiedLoader) RegisterGo(name string, constructor GoSkillConstructor)
func (l *UnifiedLoader) Load(dir string) (skill.Skill, SkillFormat, error)
func (l *UnifiedLoader) LoadAll(root string) ([]skill.Skill, error)

// Go skill registry
type GoSkillRegistry struct { ... }
func NewGoSkillRegistry() *GoSkillRegistry
func (r *GoSkillRegistry) Register(name string, constructor GoSkillConstructor)
func (r *GoSkillRegistry) Get(name string) (skill.Skill, error)
func (r *GoSkillRegistry) Has(name string) bool
func (r *GoSkillRegistry) List() []string

installer Package¶

// Dependency installation
type Manager struct {
    Timeout time.Duration
    Env     []string
    DryRun  bool
    Verbose bool
}
func NewManager() *Manager
func (m *Manager) Install(ctx context.Context, steps []loader.InstallStep) error
func (m *Manager) InstallStep(ctx context.Context, step loader.InstallStep) error
func (m *Manager) InstallMissing(ctx context.Context, steps []loader.InstallStep) error
func (m *Manager) InstallWithResults(ctx context.Context, steps []loader.InstallStep) []InstallResult
func (m *Manager) VerifyBinaries(bins []string) (missing []string)
func (m *Manager) RegisterInstaller(kind string, fn InstallerFunc)

type InstallResult struct {
    Step     loader.InstallStep
    Success  bool
    Error    error
    Duration time.Duration
}

// Skill source installation
type SkillInstaller struct {
    SkillsDir string
    GlobalDir string
    UseGlobal bool
    Symlink   bool
    Verbose   bool
}
func NewSkillInstaller() *SkillInstaller
func (i *SkillInstaller) Install(ctx context.Context, source string) (*InstalledSkill, error)
func (i *SkillInstaller) InstallGit(ctx context.Context, source *Source) (*InstalledSkill, error)
func (i *SkillInstaller) InstallLocal(ctx context.Context, source *Source) (*InstalledSkill, error)
func (i *SkillInstaller) Uninstall(name string) error
func (i *SkillInstaller) List() ([]*InstalledSkill, error)

func ParseSource(s string) (*Source, error)

registry Package¶

type Registry interface {
    Register(s skill.Skill) error
    Unregister(name string) error
    Get(name string) (skill.Skill, error)
    List() []skill.Skill
    ListTools() []skill.Tool
    GetTool(fullName string) (skill.Tool, error)
    Init(ctx context.Context) error
    Close() error
}

func New() *InMemory

var ErrSkillNotFound = errors.New("skill not found")
var ErrSkillExists = errors.New("skill already registered")

mcp/server Package¶

// Runtime creation
func New(impl *mcp.Implementation, opts *Options) *Runtime

type Options struct {
    Logger        *slog.Logger
    ServerOptions *mcp.ServerOptions
    Registry      registry.Registry
}

// Skill registration
func (r *Runtime) RegisterSkill(s skill.Skill)
func (r *Runtime) RegisterSkillWithPrefix(s skill.Skill)

// Tool registration (MCP-style)
func AddTool[In, Out any](r *Runtime, tool *mcp.Tool, handler ToolHandlerFor[In, Out])
func (r *Runtime) AddToolHandler(tool *mcp.Tool, handler mcp.ToolHandler)

// Library mode
func (r *Runtime) CallTool(ctx context.Context, name string, args any) (*mcp.CallToolResult, error)
func (r *Runtime) GetPrompt(ctx context.Context, name string, args map[string]string) (*mcp.GetPromptResult, error)
func (r *Runtime) ReadResource(ctx context.Context, uri string) (*mcp.ReadResourceResult, error)

// Server mode
func (r *Runtime) ServeStdio(ctx context.Context) error
func (r *Runtime) ServeHTTP(ctx context.Context, opts *HTTPServerOptions) (*HTTPServerResult, error)
func (r *Runtime) StreamableHTTPHandler(opts *StreamableHTTPOptions) http.Handler
func (r *Runtime) SSEHandler(opts *SSEOptions) http.Handler

// Inspection
func (r *Runtime) ListTools() []*mcp.Tool
func (r *Runtime) HasTool(name string) bool
func (r *Runtime) ToolCount() int

mcp/client Package¶

// Client creation
func New(name, version string, opts *Options) *Client

// Connection
func (c *Client) Connect(ctx context.Context, transport mcp.Transport) (*Session, error)
func (c *Client) ConnectCommand(ctx context.Context, cmd *exec.Cmd) (*Session, error)

// Session operations
func (s *Session) ListTools(ctx context.Context) ([]*mcp.Tool, error)
func (s *Session) CallTool(ctx context.Context, name string, args map[string]any) (*mcp.CallToolResult, error)
func (s *Session) ListPrompts(ctx context.Context) ([]*mcp.Prompt, error)
func (s *Session) GetPrompt(ctx context.Context, name string, args map[string]string) (*mcp.GetPromptResult, error)
func (s *Session) ListResources(ctx context.Context) ([]*mcp.Resource, error)
func (s *Session) ReadResource(ctx context.Context, uri string) (*mcp.ReadResourceResult, error)
func (s *Session) Close() error

// Session as skill
func (s *Session) AsSkill(opts ...SkillOption) *SessionSkill
func WithSkillName(name string) SkillOption
func WithSkillDescription(desc string) SkillOption