jarvis-api-contract-guard-01_skill

Overview

This skill designs and verifies API contracts with a focus on backward compatibility and repeatable development workflows. It produces measurable acceptance criteria, checkpointed execution, and implementation-ready outputs. Use it to reduce risk and speed decision-making when evolving APIs.

How this skill works

It inspects provided artifacts (code, docs, logs, screenshots) and the stated outcome and constraints to define success and failure criteria. It then builds a smallest-valid execution path, runs checkpointed validations, applies quality gates, and returns ranked findings plus a concrete action plan. Outputs include evidence, assumptions, reversible steps, and a fallback strategy.

When to use it

• When changing public or internal API surfaces and backward compatibility matters
• When you need repeatable, auditable steps and quality gates before deployment
• When deadlines and constraints require a minimal, high-confidence plan
• When handoff-ready implementation artifacts are required for engineers
• When you need a risk-first list of acceptance checks

Best practices

• Define success and failure in measurable terms before starting
• Start with a smallest-valid execution path and validate early
• Record evidence at each checkpoint for traceability
• Prefer reversible changes or feature flags for risky operations
• State assumptions and tradeoffs explicitly with each recommendation

Example use cases

• Turn messy API notes into a production-ready contract and rollout plan
• Validate a new API version for backward compatibility with concrete acceptance tests
• Produce a risk-first migration sequence with checkpoints and fallbacks
• Generate a checklist of exact commands or tests to run for verification
• Produce ownership and ETAs for each remediation or rollout step