help

Documentation

Index

• func FormatHelp(toolName, fullDescription string, params []ParamDoc, helpText string) string
• func RegisterTools(server *mcp.SerenaMCPServer, k *kernel.Kernel)
• type GetToolHelpArgs
• type HelpSkill
  • func (s *HelpSkill) Description() string
  • func (s *HelpSkill) Init(deps skill.SkillDeps) error
  • func (s *HelpSkill) Name() string
  • func (s *HelpSkill) Tools() []*mcp.ToolDef
• type ParamDoc
  • func ExtractParamDocs(inputSchema any) []ParamDoc

Functions

func FormatHelp

func FormatHelp(toolName, fullDescription string, params []ParamDoc, helpText string) string

FormatHelp formats comprehensive help text for a tool. Combines full description, parameter docs from schema, and co-located helpText.

func RegisterTools

func RegisterTools(server *mcp.SerenaMCPServer, k *kernel.Kernel)

RegisterTools registers the get_tool_help MCP tool with the server.

Types

type GetToolHelpArgs

type GetToolHelpArgs struct {
	ToolName string `json:"tool_name" jsonschema:"required,Name of the tool to get help for"`
}

GetToolHelpArgs is the input schema for the get_tool_help tool.

type HelpSkill

type HelpSkill struct{}

HelpSkill is a ToolProvider adapter that exposes the get_tool_help tool through the skill interface for daemon discovery.

func (*HelpSkill) Description

func (s *HelpSkill) Description() string

Description returns a human-readable description of this skill.

func (*HelpSkill) Init

func (s *HelpSkill) Init(deps skill.SkillDeps) error

Init is a no-op; kernel tools get their dependencies from the daemon, not SkillDeps.

func (*HelpSkill) Name

func (s *HelpSkill) Name() string

Name returns the unique skill identifier.

func (*HelpSkill) Tools

func (s *HelpSkill) Tools() []*mcp.ToolDef

Tools returns the ToolDefs for help. RegisterFn is nil because the daemon owns MCP registration (D-01).

type ParamDoc

type ParamDoc struct {
	Name        string
	Type        string
	Description string
	Required    bool
	EnumValues  []string
}

ParamDoc holds documentation for a single tool parameter.

func ExtractParamDocs

func ExtractParamDocs(inputSchema any) []ParamDoc

ExtractParamDocs extracts parameter documentation from a tool's InputSchema. Uses the same json.Marshal -> map pattern proven in suggest.go.