# API breaking change detector

> API breaking change detector is an open-source agent skill. Cross-references C# Web API controllers/DTOs against their TypeScript/JavaScript consumers (React, Angular, Vue, Svelte, Node.js, or hand-wr. It is available on Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf and Goose.

- **Kind:** Skill
- **Pricing:** Open source
- **Platforms:** Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf, Goose
- **Website:** https://github.com/github/awesome-copilot/tree/main/skills/api-breaking-change-detector
- **Repository:** https://github.com/github/awesome-copilot
- **GitHub stars:** 41,254
- **License:** MIT
- **Skill name:** api-breaking-change-detector
- **Collection:** https://github.com/github/awesome-copilot
- **Listing updated:** 2026-11-17

## About

Cross-references C# Web API controllers/DTOs against their TypeScript/JavaScript consumers (React, Angular, Vue, Svelte, Node.js, or hand-written/auto-generated HTTP clients like Fetch, Axios, NSwag) to catch contract drift in both directions: backend changes that break client applications (renamed/removed JSON keys, new required parameters, status code shifts) and frontend code sending fields the backend no longer reads. Works directly against source code, not exported OpenAPI spec files. Use when the user asks to check for breaking API changes, verify frontend/backend contract sync, or audit a DTO/controller change against its TypeScript/JS consumers before merging. Not for generating new API code from a spec (see openapi-to-application-code) or scaffolding new endpoints (see aspnet-minimal-api-openapi).

## When your agent uses it

> Cross-references C# Web API controllers/DTOs against their TypeScript/JavaScript consumers (React, Angular, Vue, Svelte, Node.js, or hand-written/auto-generated HTTP clients like Fetch, Axios, NSwag) to catch contract drift in both directions: backend changes that break client applications (renamed/removed JSON keys, new required parameters, status code shifts) and frontend code sending fields the backend no longer reads. Works directly against source code, not exported OpenAPI spec files. Use when the user asks to check for breaking API changes, verify frontend/backend contract sync, or audit a DTO/controller change against its TypeScript/JS consumers before merging. Not for generating new API code from a spec (see openapi-to-application-code) or scaffolding new endpoints (see aspnet-minimal-api-openapi).

## What it can access

From a static check of the files on GitHub; nothing was run.

- [Instructions only, no scripts](https://github.com/github/awesome-copilot/tree/HEAD/skills/api-breaking-change-detector)
- [License: MIT](https://github.com/github/awesome-copilot/tree/HEAD/skills/api-breaking-change-detector)

## Install

### Claude Code

Copy the skill folder to `~/.claude/skills/api-breaking-change-detector` to use it in all your projects:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/github/awesome-copilot.git "$tmp" &&
mkdir -p ~/.claude/skills &&
rm -rf ~/.claude/skills/api-breaking-change-detector &&
cp -R "$tmp/skills/api-breaking-change-detector" ~/.claude/skills/api-breaking-change-detector &&
rm -rf "$tmp"
```

For one project only, put the folder in `.claude/skills/api-breaking-change-detector` inside it instead.

### Codex

Copy the skill folder to `~/.agents/skills/api-breaking-change-detector` to use it in every repository:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/github/awesome-copilot.git "$tmp" &&
mkdir -p ~/.agents/skills &&
rm -rf ~/.agents/skills/api-breaking-change-detector &&
cp -R "$tmp/skills/api-breaking-change-detector" ~/.agents/skills/api-breaking-change-detector &&
rm -rf "$tmp"
```

For one repository only, put the folder in `.agents/skills/api-breaking-change-detector` inside it instead.

### Cursor

Copy the skill folder to `~/.cursor/skills/api-breaking-change-detector` to use it in every project:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/github/awesome-copilot.git "$tmp" &&
mkdir -p ~/.cursor/skills &&
rm -rf ~/.cursor/skills/api-breaking-change-detector &&
cp -R "$tmp/skills/api-breaking-change-detector" ~/.cursor/skills/api-breaking-change-detector &&
rm -rf "$tmp"
```

For one project only, put the folder in `.cursor/skills/api-breaking-change-detector` inside it instead.

### Gemini CLI

Run in a terminal (add `--scope workspace` to install it for the current workspace only):

```sh
gemini skills install https://github.com/github/awesome-copilot.git --path skills/api-breaking-change-detector
```

Or copy the folder to `~/.gemini/skills/api-breaking-change-detector` yourself.

### VS Code

For GitHub Copilot in VS Code, copy the skill folder to `~/.copilot/skills/api-breaking-change-detector`:

```sh
tmp=$(mktemp -d) &&
git clone --depth 1 https://github.com/github/awesome-copilot.git "$tmp" &&
mkdir -p ~/.copilot/skills &&
rm -rf ~/.copilot/skills/api-breaking-change-detector &&
cp -R "$tmp/skills/api-breaking-change-detector" ~/.copilot/skills/api-breaking-change-detector &&
rm -rf "$tmp"
```

For one project only, put the folder in `.github/skills/api-breaking-change-detector` inside it instead.

### Other agents

Get the folder:

```sh
git clone --depth 1 https://github.com/github/awesome-copilot.git
```

Then copy `awesome-copilot/skills/api-breaking-change-detector` into your agent's skills folder as `api-breaking-change-detector`. Agents that support SKILL.md read one folder per skill.

## FAQ

### How do I install API breaking change detector in Claude Code?

Copy the skill folder from GitHub to ~/.claude/skills/api-breaking-change-detector to use it in all your projects, or to .claude/skills/api-breaking-change-detector in one project.

### Does API breaking change detector run scripts?

No. It is instructions only, with no scripts. This comes from a static check of the files on GitHub; nothing was run. Read the files before you install it.

### Which AI agents can use API breaking change detector?

Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot, Windsurf and Goose. Each reads skills in the SKILL.md format from its own folder; the install steps on this page list them.

---
Source: https://ai-powered.com/skills/api-breaking-change-detector
