Adapter Validation¶

Every adapter must pass 13 validation rules before it can be registered with the SYNAPSE ecosystem.

Run the validator¶

synapse-validate --adapter my_module.MyAdapter
synapse-validate --adapter my_module.MyAdapter --all-fixtures

Rule	Level	Description
INGRESS_NOT_NULL	MUST	ingress() must never return null or undefined
EGRESS_RETURNS_IR	MUST	egress() must return a valid CanonicalIR object
PROVENANCE_APPENDED	MUST	egress() must append exactly one ProvenanceEntry
PROVENANCE_IMMUTABLE	MUST	egress() must not modify any existing ProvenanceEntry
TASK_HEADER_CARRIED	MUST	egress() output task_header must equal original
COMPLIANCE_CARRIED	MUST	egress() compliance_envelope must equal original
NO_NETWORK_CALLS	MUST	Adapter functions must be pure — no I/O
CONFIDENCE_RANGE	MUST	ProvenanceEntry.confidence must be in [0.0, 1.0]
MODEL_ID_MATCH	MUST	ProvenanceEntry.model_id must match adapter.modelId
VERSION_SEMVER	MUST	adapter_version must be valid semver
LATENCY_POSITIVE	SHOULD	latency_ms should be > 0
COST_NON_NEGATIVE	SHOULD	cost_usd, if present, should be >= 0.0
CONTENT_PRESERVED	SHOULD	payload.content should not be mutated by egress

PROVENANCE_IMMUTABLE

# Wrong
ir.provenance[0].confidence = 0.9

# Right
updated.provenance.append(self.build_provenance(confidence=0.9, latency_ms=latency_ms))

TASK_HEADER_CARRIED

updated = original_ir.copy()  # carries task_header automatically