relate_skill

Overview

This skill is a deprecated compatibility wrapper that routes requests to the synthesize tool with format='comparison'. It exists only to preserve behavior for older integrations. New code should call synthesize directly with the comparison format.

How this skill works

When invoked, the skill forwards input and parameters to the synthesize tool and sets format='comparison' to reproduce legacy output. It performs minimal validation and does not implement its own synthesis logic. Any options supported by synthesize are honored when passed through.

When to use it

• Maintaining older projects that still call relate and cannot be updated immediately.
• Gradual migration strategies where you update callers in stages.
• CI jobs or scripts that depend on the legacy entrypoint and need short-term continuity.
• Verifying that synthesize with format='comparison' reproduces previous outputs before refactoring.
• Avoid for new development — call synthesize directly.

Best practices

• Replace calls to relate with synthesize(format='comparison') in codebases as soon as feasible.
• Run tests to confirm identical outputs after switching to synthesize directly.
• Avoid adding new logic to the wrapper; keep it transient and simple.
• Document the migration timeline for your team and prioritize updating public APIs.
• Pin dependency versions while migrating to prevent unexpected changes in synthesize behavior.

Example use cases

• A legacy service still calling relate while you stage a release that replaces it with synthesize.
• Automated scripts that generate comparison reports and need a no-op compatibility layer during refactor.
• A CI pipeline that temporarily redirects relate calls to synthesize to validate equivalence before deprecating the old endpoint.