Api Compatibility Analysis logo

Api Compatibility Analysis

Community
Sahil-SS9
api-compatibility-analysis

Classify every proposed API change as compatible or breaking across all three dimensions.

Overview

PublisherSahil-SS9
Repositoryagent-personas
Skill nameapi-compatibility-analysis
Stars
67
Forks
4
Bundled files
1
LicenseMIT
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 1 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by Sahil-SS9 on GitHub. Read the source before you install it.

Installation

Install the Api Compatibility Analysis AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/Sahil-SS9/agent-personas/tree/main/skills/api-compatibility-analysis
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/Sahil-SS9/agent-personas.git /tmp/agent-personas
mkdir -p .claude/skills
cp -r /tmp/agent-personas/skills/api-compatibility-analysis .claude/skills/api-compatibility-analysis
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Api Compatibility Analysis in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Api Compatibility Analysis on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Api Compatibility Analysis is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

API compatibility analysis

When to use

Every proposed change to a published contract, without exception.

Procedure

  1. Check all three dimensions: source compatibility (client code compiles/runs), wire compatibility (serialization matches), semantic compatibility (reasonable expectations hold). Old clients must keep working within a major version.
  2. Classify the change: SAFE — adding optional components, adding enum values to request-only enums, additive fields with back-compatible defaults. BREAKING — removing or renaming anything (rename = remove+add), moving fields between files or into/out of oneofs, changing field types, changing resource names, changing defaults, changing value formats (e.g. IPv4 → IPv6), changing default serialization.
  3. Apply the judgement rule: code depends on behaviour even when undocumented — do not change visible semantics reasonable user code relies on. When in doubt, it is breaking.
  4. For breaking needs: new major version; version explicitly (semver-shaped); announce deprecations with timelines and a migration path; never remove in minor/patch.

Decision rules

  • Every change gets a written compatible/breaking classification with reasoning — "should be fine" is not a classification.
  • Prefer additive evolution; when a replacement field is added alongside the old, specify resolution of conflicting inputs explicitly.
  • Pagination added after launch must not shrink what older clients receive by default.

Pitfalls

  • Treating wire-compatible as safe when source compatibility breaks (type changes, file moves).
  • Silently changing output-only field formats.

Done

Per-change classification across all three dimensions with a versioning decision and deprecation path where breaking.

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Api Compatibility Analysis AI skill do?

Classify every proposed API change as compatible or breaking across all three dimensions.

Why use Api Compatibility Analysis on TypingMind?

Because you install it once and use it with any model. Api Compatibility Analysis is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Api Compatibility Analysis in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/Sahil-SS9/agent-personas/tree/main/skills/api-compatibility-analysis. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Api Compatibility Analysis?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Api Compatibility Analysis?

As many as you like. As long as a model supports skills, you can use Api Compatibility Analysis with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Api Compatibility Analysis AI skill free?

Yes. It is published on GitHub by Sahil-SS9 under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇