Documentation
¶
Overview ¶
Package skill provides the single-source MCPlex Code Mode documentation registry, slim progressive-disclosure instructions, and on-demand topic/keyword lookup for the `docs` MCP tool.
Index ¶
- func CompactExecDescription(defaultMaxOutBytes int) string
- func CompactExecDescriptionForTools(defaultMaxOutBytes int, hasRead, hasTasks bool) string
- func CompactExecDescriptionForToolset(defaultMaxOutBytes int, hasRead, hasTasks, hasDocs bool) string
- func FullGuide() string
- func FullGuideForTools(hasRead, hasTasks bool) string
- func FullGuideForToolset(hasRead, hasTasks, hasDocs bool) string
- func Instructions() string
- func InstructionsForTools(hasRead, hasTasks bool) string
- func InstructionsForToolset(hasRead, hasTasks, hasDocs bool) string
- func Lookup(topic, query string, hasRead, hasTasks bool) string
- func TopicIndex(hasRead, hasTasks bool) string
- type DocTopic
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CompactExecDescription ¶
CompactExecDescription returns a concise self-describing tool description for `exec`.
func CompactExecDescriptionForTools ¶ added in v0.3.0
CompactExecDescriptionForTools returns a slim (~520B) `exec` tool description (assuming `docs` is enabled).
func CompactExecDescriptionForToolset ¶ added in v0.4.0
func CompactExecDescriptionForToolset(defaultMaxOutBytes int, hasRead, hasTasks, hasDocs bool) string
CompactExecDescriptionForToolset returns a slim (~520B) `exec` tool description tailored to the exact active toolset.
func FullGuide ¶
func FullGuide() string
FullGuide returns the complete Markdown Code Mode skill manual (served via mcplex://skill and `mcplex skill`).
func FullGuideForTools ¶ added in v0.3.0
FullGuideForTools dynamically assembles the complete Markdown manual from the single-source topic registry.
func FullGuideForToolset ¶ added in v0.4.0
FullGuideForToolset dynamically assembles the complete Markdown manual for the exact active toolset.
func Instructions ¶
func Instructions() string
Instructions returns the slim progressive-disclosure instructions returned in MCP initialize.result.instructions.
func InstructionsForTools ¶ added in v0.3.0
InstructionsForTools returns a compact (~600B) routing guide tailored to hasRead and hasTasks (assuming docs is enabled).
func InstructionsForToolset ¶ added in v0.4.0
InstructionsForToolset returns a compact (~600B) routing guide tailored to the exact active toolset, omitting references to `docs` when `hasDocs` is false (e.g. `--tools exec`).
func Lookup ¶ added in v0.4.0
Lookup resolves an on-demand `docs` tool request by topic (exact ID or alias) and/or keyword query.
func TopicIndex ¶ added in v0.4.0
TopicIndex renders a compact table of contents returned by `docs()` with no arguments.