Documentation
¶
Overview ¶
Package codexkit provides the ToolModule interface and shared types used by all codexkit packages.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var PortableFrontmatterKeys = map[string]bool{ "name": true, "description": true, "allowed-tools": true, "reload": true, }
PortableFrontmatterKeys are the only keys allowed in portable skill frontmatter per the Agent Skills open standard (Dec 2025).
Functions ¶
This section is empty.
Types ¶
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry holds all registered ToolModules and dispatches tool calls.
func (*Registry) ListModules ¶
ListModules returns the names of all registered modules.
func (*Registry) Register ¶
func (r *Registry) Register(m ToolModule) error
Register adds a module and indexes its tools. Init is called once.
type ToolDef ¶
type ToolDef struct {
// Name is the tool identifier (e.g. "baseline_check").
Name string `json:"name"`
// Description is a short human-readable summary.
Description string `json:"description"`
// Schema is the JSON Schema for the tool's input parameters.
// nil means the tool takes no parameters.
Schema map[string]any `json:"inputSchema,omitempty"`
// Handler executes the tool with the given parameters and returns
// a result or error.
Handler func(params map[string]any) (any, error) `json:"-"`
}
ToolDef describes a single tool exposed by a module.
type ToolModule ¶
type ToolModule interface {
// Name returns the module identifier (e.g. "baselineguard").
Name() string
// Tools returns the tool definitions provided by this module.
Tools() []ToolDef
// Init performs any one-time setup. Called before first tool use.
Init() error
}
ToolModule is the interface that all codexkit packages implement. It is modeled after claudekit's ToolModule pattern: each package registers itself as a named module exposing a set of typed tool definitions that can be aggregated by the MCP server or CLI.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package baselineguard validates Codex repo baseline requirements.
|
Package baselineguard validates Codex repo baseline requirements. |
|
cmd
|
|
|
codexkit
command
|
|
|
codexkit-global-mcp
command
|
|
|
codexkit-mcp
command
Command codexkit-mcp runs the codexkit MCP server over stdio.
|
Command codexkit-mcp runs the codexkit MCP server over stdio. |
|
Package fleetaudit runs aggregate validation across all repos in a scan directory (default ~/hairglasses-studio).
|
Package fleetaudit runs aggregate validation across all repos in a scan directory (default ~/hairglasses-studio). |
|
internal
|
|
|
toml
Package toml provides a minimal TOML writer for generating .codex/config.toml sections.
|
Package toml provides a minimal TOML writer for generating .codex/config.toml sections. |
|
Package mcpserver implements an MCP (Model Context Protocol) server that aggregates all codexkit ToolModules and exposes them via JSON-RPC over stdio.
|
Package mcpserver implements an MCP (Model Context Protocol) server that aggregates all codexkit ToolModules and exposes them via JSON-RPC over stdio. |
|
Package mcpsync synchronizes repo-local MCP definitions into the generated Codex config block used by the workspace.
|
Package mcpsync synchronizes repo-local MCP definitions into the generated Codex config block used by the workspace. |
|
Package perfaudit scans the workspace for Codex performance bottlenecks.
|
Package perfaudit scans the workspace for Codex performance bottlenecks. |
|
Package skillsync synchronizes canonical .agents skills onto the managed Claude and plugin mirrors used across the workspace.
|
Package skillsync synchronizes canonical .agents skills onto the managed Claude and plugin mirrors used across the workspace. |