Skip to content

Validation

validation

Input validation for Crux CLI.

Provides validation functions for MCP/skill names, registry schema, and crux.json project files.

validate_name 

validate_name(name)

Validate an MCP or skill name.

Rules: - Lowercase alphanumeric characters and hyphens only - Must start and end with an alphanumeric character - Between 2 and 50 characters inclusive

Returns (True, "") on success, or (False, reason) on failure.

Source code in src/crux_cli/validation.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
def validate_name(name: str) -> tuple[bool, str]:
    """Validate an MCP or skill name.

    Rules:
    - Lowercase alphanumeric characters and hyphens only
    - Must start and end with an alphanumeric character
    - Between 2 and 50 characters inclusive

    Returns (True, "") on success, or (False, reason) on failure.
    """
    if len(name) < _MIN_NAME_LEN:
        return False, f"Name must be at least {_MIN_NAME_LEN} characters, got {len(name)}"
    if len(name) > _MAX_NAME_LEN:
        return False, f"Name must be at most {_MAX_NAME_LEN} characters, got {len(name)}"
    if name != name.lower():
        return False, "Name must be lowercase"
    if not _NAME_PATTERN.match(name):
        return False, (
            "Name must contain only lowercase alphanumeric characters and hyphens,"
            " and start/end with alphanumeric"
        )
    return True, ""

validate_registry 

validate_registry(data)

Validate registry.json structure.

Source code in src/crux_cli/validation.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def validate_registry(data: dict[str, Any]) -> tuple[bool, list[str]]:
    """Validate registry.json structure."""
    errors: list[str] = []

    if not isinstance(data, dict):
        return False, ["Registry must be a JSON object"]

    if "version" not in data:
        errors.append("Missing required field: version")

    for name, defn in data.get("mcp_definitions", {}).items():
        ok, reason = validate_name(name)
        if not ok:
            errors.append(f"Invalid MCP name '{name}': {reason}")
        if not isinstance(defn, dict):
            errors.append(f"MCP '{name}' definition must be an object")
            continue
        mcp_type = defn.get("type")
        if mcp_type and mcp_type not in _VALID_MCP_TYPES:
            errors.append(f"MCP '{name}' has invalid type '{mcp_type}' (valid: {', '.join(sorted(_VALID_MCP_TYPES))})")

    for name, defn in data.get("skill_definitions", {}).items():
        ok, reason = validate_name(name)
        if not ok:
            errors.append(f"Invalid skill name '{name}': {reason}")
        if not isinstance(defn, dict):
            errors.append(f"Skill '{name}' definition must be an object")

    return len(errors) == 0, errors

validate_crux_json 

validate_crux_json(data)

Validate a project's crux.json structure.

Source code in src/crux_cli/validation.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
def validate_crux_json(data: dict[str, Any]) -> tuple[bool, list[str]]:
    """Validate a project's crux.json structure."""
    errors: list[str] = []

    if not isinstance(data, dict):
        return False, ["crux.json must be a JSON object"]

    if "name" not in data:
        errors.append("Missing required field: name")

    mcps = data.get("mcps")
    if mcps is not None and not isinstance(mcps, list):
        errors.append("'mcps' must be a list")

    skills = data.get("skills")
    if skills is not None and not isinstance(skills, list):
        errors.append("'skills' must be a list")

    return len(errors) == 0, errors