skills.rest
ql-link
ql-linkOFFICIAL
Explore all skills by this author →
GitHub

contract-guard

Identify cross-module contract changes and generate migration plans.

5|1|Updated May 9, 2026
Search Tags:#architecture#documentation#migration#contract#code-change#cross-service
One-click install
npx skills add https://github.com/ql-link/LinkRag --skill contract-guard
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: contract-guard
Source: https://github.com/ql-link/LinkRag/tree/main/.ai/skills/contract-guard
Command: npx skills add https://github.com/ql-link/LinkRag --skill contract-guard

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that modifications to shared contracts across modules or services do not silently break compatibility, and it surfaces the exact contract documents and migration tasks that must be updated.

Core Features & Use Cases

  • Evaluate changes to cross-module/public contracts including MySQL schema, vector/index structures, MQ topics, object storage paths, HTTP interfaces, and error codes.
  • Generate a precise list of documents and migrations that must be synchronized, without modifying any content.
  • Use Case: When a design or code change touches a shared contract, run this skill to obtain the required synchronization artifacts and migration plan.

Quick Start

Run this skill to determine contract impact and enumerate required contract documents and migrations for a given change.

Frequently Asked Questions about contract-guard

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if code changes break cross-service API contracts?▼

To check if code changes break cross-service API contracts, analyze modifications against shared interfaces like HTTP endpoints and error codes. This identifies compatibility risks and outputs a list of required synchronization documents without altering source code.

What is cross-module contract migration synchronization?▼

Cross-module contract migration synchronization is the process of tracking shared structural changes across MySQL schemas, MQ topics, and OSS paths. It generates a precise list of contract documents and migration tasks that must be updated to maintain system integrity.

How do I generate migration tasks for MySQL schema and vector index changes?▼

Generate migration tasks for MySQL schema and vector index changes by evaluating the modifications against existing public contracts. This produces a concrete migration and documentation plan detailing exactly what must be synchronized across components.

Does this contract evaluation modify my existing source code?▼

This contract evaluation does not modify your existing source code. It performs structure-level integrity checks and cross-system compatibility guarantees, outputting only a concrete migration and documentation plan for required synchronization.

When do I need to run a shared contract compatibility check?▼

You need to run a shared contract compatibility check when a design or code change touches shared contracts across multiple components and services. This determines if modifications break compatibility across MQ messages, HTTP interfaces, or error codes.

Related Skills

Explore More Software Engineering Skills→
jshsakurajshsakura
22

terraform-engineer

Analyze Terraform module interfaces, state integrity, and lifecycle semantics to mitigate infrastructure risks.

Community
Advanced
ql-linkql-link
5

mq-middleware

Integrate and orchestrate Kafka and RabbitMQ messaging for the toLink-Rag platform.

Official
Advanced
snhrmsnhrm

dependency-analyzer

Fetch npm and endoflife.date data to report EOL status and compatibility for JavaScript libraries.

Community
Advanced
JsplixJsplix

code-review-pr-body

Generate structured pull request body drafts from git diffs.

Community
Intermediate