Validation API

Headless validation for scripts, services, and MCP tools.

Full registry validation

from opentide.validation.session import run_validation
from opentide.validation.scope import ValidationScope

report = run_validation(scope=ValidationScope.full())
print(report.ok)
for issue in report.errors:
    print(issue.to_legacy_string())

Narrow scope

scope = ValidationScope.narrow(
    files=frozenset({"objects/rules/example.yaml"}),
    uuids=frozenset({"<uuid>"}),
    types=frozenset({"rule"}),
)
report = run_validation(scope=scope)

Check selection

from opentide.validation.checks.kinds import ValidateCheck

report = run_validation(
    scope=ValidationScope.full(),
    checks=frozenset({ValidateCheck.schema, ValidateCheck.cve}),
)

Available checks: id-uniqueness, uuid-format, schema, cve.

Default pipeline checks: id uniqueness, UUID format, schema.

ValidationReport

Structured report with:

• ok — overall pass/fail
• errors, warnings — ValidationIssue lists
• model_dump_json_ready() — JSON-safe dict for APIs

MCP validation_report tool returns this shape.

Single rule via registry

from opentide import OpenTide

OpenTide.initialise()
rule = OpenTide.Rules[uuid]
result = OpenTide.validate_rule(rule)

Query validation

Query validation is a platform plugin concern, separate from object validation above. Two Python paths exist:

from opentide import OpenTide
OpenTide.initialise()

rule = OpenTide.Rules[uuid]
result = rule.validate_query("sentinel")   # ValidationResult
print(result.ok, result.errors)

rule.validate_query(platform) delegates to the platform's registered validator. It works for the five platforms that ship validators — sentinel, defender_for_endpoint, splunk, sentinel_one, carbon_black_cloud — and reports unsupported (not a fake pass) for crowdstrike and harfanglab. Check capability first:

if OpenTide.Platforms["sentinel"].can_validate:
    result = rule.validate_query("sentinel")

A failed query validation may raise Errors.TideQueryValidationError for exceptional cases; expected pass/fail is returned in the ValidationResult. See Models → errors.

Source

src/opentide/validation/session.py, src/opentide/validation/scope.py, src/opentide/validation/issues.py