Skip to main content

Module spec

Module spec 

Source
Expand description

Caller-supplied description of a hook (or MCP server, or skill) to install.

Structs§

HookRuntimeOptions
Optional execution configuration for command hooks.
HookSpec
Everything an Integration needs to install a hook.
HookSpecBuilder
Builder for HookSpec.
InstructionSpec
Caller-supplied description of a standalone instruction file to install.
InstructionSpecBuilder
Builder for InstructionSpec.
McpSpec
Caller-supplied description of an MCP server to register with a harness.
McpSpecBuilder
Builder for McpSpec.
RulesBlock
Markdown content to inject into the harness’s memory/rules file, fenced by HTML comments keyed on the HookSpec::tag.
SkillAsset
One supporting file inside a skill directory.
SkillFrontmatter
YAML frontmatter prepended to SKILL.md.
SkillSpec
Caller-supplied description of an agent skill to install.
SkillSpecBuilder
Builder for SkillSpec.

Enums§

Event
Lifecycle event to attach to. Each integration maps this to its harness’s own event name (e.g., PreToolUse on Claude Code, BeforeTool on Gemini, tool.execute.before on OpenCode).
HookCommand
Hook command representation.
InstructionPlacement
How an instruction file should be placed relative to the agent’s config.
Matcher
Which tool calls a hook should match.
McpTransport
How an MCP server is reached.
ScriptTemplate
Optional script body for harnesses that need a shell script or TS plugin.
SecretPolicy
Policy for env values that look secret-bearing in project-local MCP config.
SkillContext
Claude skill context mode.
SkillEffort
Claude skill effort override.
SkillShell
Claude skill shell for inline shell snippets.