mirror of https://github.com/mark3labs/kit.git synced 2026-06-14 03:30:26 +00:00

Files

T

Ed Zynda 7fc94018a9 rename: fork mcphost to kit (github.com/mark3labs/kit)

Rename the entire project from mcphost to kit, including:
- Go module path and all import paths
- SDK type MCPHost -> Kit, file renames mcphost.go -> kit.go
- CLI command name, usage strings, UI labels (KIT in literature)
- Config paths (.mcphost -> .kit), env prefix (MCPHOST_ -> KIT_)
- Data/credential/hooks directory paths
- Remove legacy .mcp config fallbacks
- Session metadata field (mcphost_version -> kit_version)
- MCP client identity name
- Build output, goreleaser binary name
- All documentation, examples, scripts, and test files

2026-02-26 16:59:59 +03:00

2.5 KiB

Raw Blame History

KIT Script Examples

This directory contains example scripts demonstrating various features of KIT's script mode.

Scripts

`default-values-demo.sh`

Demonstrates the new default values feature for script variables.

Features showcased:

Optional variables with default values using ${var:-default} syntax
Mixed required and optional variables
Default values in MCP server configuration
Complex default values (paths, commands, formats)

Usage:

# Use all defaults
kit script default-values-demo.sh

# Override specific variables
kit script default-values-demo.sh --args:user_name "John" --args:work_dir "/projects"

# Override multiple variables
kit script default-values-demo.sh \
  --args:user_name "Alice" \
  --args:editor "vim" \
  --args:format "json"

`tls-test-script.sh`

Demonstrates TLS skip verify for connecting to providers with self-signed certificates.

Features showcased:

tls-skip-verify configuration in script frontmatter
Connecting to HTTPS endpoints with self-signed certificates
Security considerations for development environments

Usage:

# Run with TLS skip verify enabled (configured in script)
kit script tls-test-script.sh

# Override the provider URL
kit script tls-test-script.sh --provider-url https://192.168.1.100:443

# Disable TLS skip verify via command line (overrides script config)
kit script tls-test-script.sh --tls-skip-verify=false

⚠️ WARNING: Only use tls-skip-verify for development or when connecting to trusted servers with self-signed certificates.

Variable Syntax Reference

KIT scripts support two types of variables:

Required Variables

${variable}

Must be provided via --args:variable value
Script will fail if not provided

Optional Variables with Defaults

${variable:-default_value}

Uses default_value if not provided
Can be overridden with --args:variable value
Supports empty defaults: ${var:-}
Supports complex defaults: ${path:-/tmp/default/path}

Best Practices

Use descriptive variable names: ${user_name} instead of ${name}
Provide sensible defaults: Choose defaults that work in most environments
Document variables: Include usage examples in script comments
Mix required and optional: Use required variables for critical inputs, optional for preferences
Test with defaults: Ensure scripts work with all default values

Backward Compatibility

All existing scripts using ${variable} syntax continue to work unchanged. The new default syntax is purely additive.

2.5 KiB Raw Blame History