Documentation
¶
Overview ¶
Package assistantkit provides a unified interface for managing configuration files across multiple AI coding assistants including Claude Code, Cursor, Windsurf, VS Code, OpenAI Codex CLI, Cline, and Roo Code.
Assistant Kit supports multiple configuration types:
- MCP (Model Context Protocol) server configurations
- Hooks (automation/lifecycle callbacks)
- Settings (permissions, sandbox, general settings) - coming soon
- Rules (team rules, coding guidelines) - coming soon
- Memory (CLAUDE.md, .cursorrules, etc.) - coming soon
MCP Configuration ¶
The mcp subpackage provides adapters for reading, writing, and converting MCP server configurations between different AI assistant formats.
Example usage:
import (
"github.com/agentplexus/assistantkit/mcp"
"github.com/agentplexus/assistantkit/mcp/claude"
"github.com/agentplexus/assistantkit/mcp/vscode"
)
// Read Claude config and write to VS Code format
cfg, _ := claude.ReadProjectConfig()
vscode.WriteWorkspaceConfig(cfg)
// Or use dynamic conversion
data, _ := mcp.Convert(jsonData, "claude", "vscode")
Hooks Configuration ¶
The hooks subpackage provides adapters for automation/lifecycle callbacks that execute at defined stages of the agent loop.
Example usage:
import (
"github.com/agentplexus/assistantkit/hooks"
"github.com/agentplexus/assistantkit/hooks/claude"
)
// Create hooks configuration
cfg := hooks.NewConfig()
cfg.AddHook(hooks.BeforeCommand, hooks.NewCommandHook("echo 'before'"))
// Write to Claude format
claude.WriteProjectConfig(cfg)
// Or convert between formats
data, _ := hooks.Convert(jsonData, "claude", "cursor")
Related Projects ¶
Assistant Kit is part of the AgentPlexus family of Go modules:
- Assistant Kit - AI coding assistant configuration management
- OmniVault - Unified secrets management
- OmniLLM - Multi-provider LLM abstraction
- OmniSerp - Search engine abstraction
- OmniObserve - LLM observability abstraction
Index ¶
Constants ¶
const Version = "0.7.0"
Version is the current version of Assistant Kit.
Variables ¶
This section is empty.
Functions ¶
func SupportedTools ¶
func SupportedTools() []string
SupportedTools returns a list of AI coding tools that Assistant Kit supports.
Types ¶
type ConfigType ¶
type ConfigType string
ConfigType represents the type of configuration.
const ( // ConfigTypeMCP represents MCP server configuration. ConfigTypeMCP ConfigType = "mcp" // ConfigTypeHooks represents hooks/automation configuration. ConfigTypeHooks ConfigType = "hooks" // ConfigTypeSettings represents general settings configuration. ConfigTypeSettings ConfigType = "settings" // ConfigTypeRules represents team rules configuration. ConfigTypeRules ConfigType = "rules" // ConfigTypeMemory represents memory/context configuration. ConfigTypeMemory ConfigType = "memory" )
func SupportedConfigTypes ¶
func SupportedConfigTypes() []ConfigType
SupportedConfigTypes returns a list of configuration types that Assistant Kit supports.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package agents provides adapters for AI assistant agent definitions.
|
Package agents provides adapters for AI assistant agent definitions. |
|
agentkit
Package agentkit provides an adapter for generating agentkit local server configurations.
|
Package agentkit provides an adapter for generating agentkit local server configurations. |
|
awsagentcore
Package awsagentcore provides an adapter for generating AWS Bedrock AgentCore CDK deployments.
|
Package awsagentcore provides an adapter for generating AWS Bedrock AgentCore CDK deployments. |
|
claude
Package claude provides the Claude Code agent adapter.
|
Package claude provides the Claude Code agent adapter. |
|
codex
Package codex provides the OpenAI Codex CLI agent adapter.
|
Package codex provides the OpenAI Codex CLI agent adapter. |
|
core
Package core provides the canonical agent definition types.
|
Package core provides the canonical agent definition types. |
|
gemini
Package gemini provides the Gemini CLI agent adapter.
|
Package gemini provides the Gemini CLI agent adapter. |
|
kiro
Package kiro provides the AWS Kiro CLI agent adapter.
|
Package kiro provides the AWS Kiro CLI agent adapter. |
|
Package bundle provides a unified type for AI assistant plugin bundles.
|
Package bundle provides a unified type for AI assistant plugin bundles. |
|
cmd
|
|
|
assistantkit
command
Command assistantkit provides CLI tools for AI assistant plugin development.
|
Command assistantkit provides CLI tools for AI assistant plugin development. |
|
genagents
command
Command genagents generates platform-specific agent files from canonical specs.
|
Command genagents generates platform-specific agent files from canonical specs. |
|
generate
command
Command generate converts CONTEXT.json to tool-specific formats.
|
Command generate converts CONTEXT.json to tool-specific formats. |
|
Package commands provides adapters for AI assistant command/prompt definitions.
|
Package commands provides adapters for AI assistant command/prompt definitions. |
|
claude
Package claude provides the Claude Code command adapter.
|
Package claude provides the Claude Code command adapter. |
|
codex
Package codex provides the OpenAI Codex CLI prompt adapter.
|
Package codex provides the OpenAI Codex CLI prompt adapter. |
|
core
Package core provides canonical types for AI assistant command/prompt definitions.
|
Package core provides canonical types for AI assistant command/prompt definitions. |
|
gemini
Package gemini provides the Gemini CLI command adapter.
|
Package gemini provides the Gemini CLI command adapter. |
|
Package context provides a tool-agnostic system for managing project context that can be converted to various AI assistant formats (CLAUDE.md, .cursorrules, etc.).
|
Package context provides a tool-agnostic system for managing project context that can be converted to various AI assistant formats (CLAUDE.md, .cursorrules, etc.). |
|
claude
Package claude provides a converter for generating CLAUDE.md files from the canonical project context format.
|
Package claude provides a converter for generating CLAUDE.md files from the canonical project context format. |
|
core
Package core provides the canonical types for project context that can be converted to various AI assistant formats (CLAUDE.md, .cursorrules, etc.).
|
Package core provides the canonical types for project context that can be converted to various AI assistant formats (CLAUDE.md, .cursorrules, etc.). |
|
Package generate provides functions for generating platform-specific plugins from canonical JSON specifications.
|
Package generate provides functions for generating platform-specific plugins from canonical JSON specifications. |
|
Package hooks provides a unified interface for managing hook configurations across multiple AI coding assistants.
|
Package hooks provides a unified interface for managing hook configurations across multiple AI coding assistants. |
|
claude
Package claude provides an adapter for Claude Code hooks configuration.
|
Package claude provides an adapter for Claude Code hooks configuration. |
|
core
Package core provides the canonical types for hook configuration that can be converted to/from various AI assistant formats.
|
Package core provides the canonical types for hook configuration that can be converted to/from various AI assistant formats. |
|
cursor
Package cursor provides an adapter for Cursor IDE hooks configuration.
|
Package cursor provides an adapter for Cursor IDE hooks configuration. |
|
windsurf
Package windsurf provides an adapter for Windsurf (Codeium) hooks configuration.
|
Package windsurf provides an adapter for Windsurf (Codeium) hooks configuration. |
|
Package mcp provides a unified interface for managing MCP (Model Context Protocol) server configurations across multiple AI coding assistants.
|
Package mcp provides a unified interface for managing MCP (Model Context Protocol) server configurations across multiple AI coding assistants. |
|
claude
Package claude provides an adapter for Claude Code / Claude Desktop MCP configuration files (.mcp.json).
|
Package claude provides an adapter for Claude Code / Claude Desktop MCP configuration files (.mcp.json). |
|
cline
Package cline provides an adapter for Cline VS Code extension MCP configuration.
|
Package cline provides an adapter for Cline VS Code extension MCP configuration. |
|
codex
Package codex provides an adapter for OpenAI Codex CLI MCP configuration.
|
Package codex provides an adapter for OpenAI Codex CLI MCP configuration. |
|
core
Package core provides the canonical types for MCP server configuration that can be converted to/from various AI assistant formats.
|
Package core provides the canonical types for MCP server configuration that can be converted to/from various AI assistant formats. |
|
cursor
Package cursor provides an adapter for Cursor IDE MCP configuration.
|
Package cursor provides an adapter for Cursor IDE MCP configuration. |
|
kiro
Package kiro provides an adapter for AWS Kiro CLI MCP configuration.
|
Package kiro provides an adapter for AWS Kiro CLI MCP configuration. |
|
roo
Package roo provides an adapter for Roo Code VS Code extension MCP configuration.
|
Package roo provides an adapter for Roo Code VS Code extension MCP configuration. |
|
vscode
Package vscode provides an adapter for VS Code / GitHub Copilot MCP configuration.
|
Package vscode provides an adapter for VS Code / GitHub Copilot MCP configuration. |
|
windsurf
Package windsurf provides an adapter for Windsurf (Codeium) MCP configuration.
|
Package windsurf provides an adapter for Windsurf (Codeium) MCP configuration. |
|
Package plugins provides adapters for AI assistant plugin/extension manifests.
|
Package plugins provides adapters for AI assistant plugin/extension manifests. |
|
claude
Package claude provides the Claude Code plugin adapter.
|
Package claude provides the Claude Code plugin adapter. |
|
core
Package core provides canonical types for AI assistant plugin/extension definitions.
|
Package core provides canonical types for AI assistant plugin/extension definitions. |
|
gemini
Package gemini provides the Gemini CLI extension adapter.
|
Package gemini provides the Gemini CLI extension adapter. |
|
powers
|
|
|
core
Package core provides canonical power definition types.
|
Package core provides canonical power definition types. |
|
kiro
Package kiro provides the Kiro IDE power adapter.
|
Package kiro provides the Kiro IDE power adapter. |
|
Package publish provides publishers for submitting plugins to AI assistant marketplaces.
|
Package publish provides publishers for submitting plugins to AI assistant marketplaces. |
|
claude
Package claude provides a publisher for the Claude Code official marketplace.
|
Package claude provides a publisher for the Claude Code official marketplace. |
|
core
Package core provides the Publisher interface for marketplace submissions.
|
Package core provides the Publisher interface for marketplace submissions. |
|
github
Package github provides GitHub API utilities for marketplace submissions.
|
Package github provides GitHub API utilities for marketplace submissions. |
|
Package requirements provides dependency checking and HITL installation prompts for assistant runtimes.
|
Package requirements provides dependency checking and HITL installation prompts for assistant runtimes. |
|
Package skills provides adapters for AI assistant skill definitions.
|
Package skills provides adapters for AI assistant skill definitions. |
|
claude
Package claude provides the Claude Code skill adapter.
|
Package claude provides the Claude Code skill adapter. |
|
codex
Package codex provides the OpenAI Codex skill adapter.
|
Package codex provides the OpenAI Codex skill adapter. |
|
core
Package core provides canonical types for AI assistant skill definitions.
|
Package core provides canonical types for AI assistant skill definitions. |
|
kiro
Package kiro provides the Kiro CLI skill adapter for steering files.
|
Package kiro provides the Kiro CLI skill adapter for steering files. |
|
Package teams provides multi-agent team orchestration definitions.
|
Package teams provides multi-agent team orchestration definitions. |
|
core
Package core provides canonical types for multi-agent team orchestration.
|
Package core provides canonical types for multi-agent team orchestration. |
|
Package validation provides configuration types for release validation areas.
|
Package validation provides configuration types for release validation areas. |
|
claude
Package claude provides the Claude Code validation area adapter.
|
Package claude provides the Claude Code validation area adapter. |
|
cmd/generate
command
Command generate creates validation area files from canonical specs.
|
Command generate creates validation area files from canonical specs. |
|
codex
Package codex provides the OpenAI Codex validation area adapter.
|
Package codex provides the OpenAI Codex validation area adapter. |
|
core
Package core provides canonical types for validation area definitions.
|
Package core provides canonical types for validation area definitions. |
|
gemini
Package gemini provides the Gemini CLI validation area adapter.
|
Package gemini provides the Gemini CLI validation area adapter. |