Api Schema Validation logo

Api Schema Validation

Community
naodeng
api-schema-validation

Use this skill when you need to compare API schemas with sourced request and response evidence; triggers include API Schema 校验 and API schema validation.

Overview

Publishernaodeng
Repositoryawesome-qa-skills
Skill nameapi-schema-validation
Stars
279
Forks
36
Bundled files
10
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.

  • 10 bundled files

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

  • Open source

    Published by naodeng on GitHub. Read the source before you install it.

Installation

Install the Api Schema Validation 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/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-schema-validation
  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/naodeng/awesome-qa-skills.git /tmp/awesome-qa-skills
mkdir -p .claude/skills
cp -r /tmp/awesome-qa-skills/skills/en/testing-types/api-schema-validation .claude/skills/api-schema-validation
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Api Schema Validation 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 Schema Validation 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 Schema Validation 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 Schema Validation

compare API schema constraints with sourced request, response, and version evidence. Produce ASV-## findings. This Skill organizes traceable API-quality candidates only; it does not execute tests or turn a design inventory into coverage, pass, or release evidence.

When to Use

  • When you need API schema validation candidates from OpenAPI, JSON Schema, GraphQL schemas, endpoint inventories, request-response samples, versions, and validation reports.
  • When you need selection rationale, applicability constraints, evidence gaps, and the smallest validation action.
  • When inputs are incomplete but a bounded first pass can preserve blocked or unassessed boundaries.

Do not use it to execute tests, invent contract or behavior, replace a complete strategy, or accept risk for a Human.

Output Format Options

  • Use Markdown by default; use tables, JSON, or CSV only when explicitly requested or required by the delivery format.
  • Separate static analysis, unexecuted work, evidence states, and Human decisions; keep items unassessed, blocked, or NOT_RUN when runtime evidence is absent.

How to Use

  1. Read prompts/api-schema-validation.md and provide the objective, scope, material, environment, and evidence.
  2. Complete the known, missing, conflicting, stale, out_of_scope, and assumptions input audit before findings.
  3. Record ASV-## with the subject, preconditions, behavior of concern, source evidence, and validation, plus impact/priority, owner role, close condition, and evidence state.
  4. Preserve conflicts, unknown constraints, and open questions when evidence is incomplete.

Domain Execution Essentials

  • Identify OpenAPI/JSON Schema/GraphQL and its version/dialect, operation/direction, content type, reference root and resolution context. Suspend version-dependent decisions when unknown.
  • Deliver dialect, reference-resolution status, and sample/constraint decisions; required presence and a null value must be assessed separately.
  • When deriving domain candidates, read and follow prompts/api-schema-validation.md for the domain procedure and oracle; retain valid controls, evidence gaps, and validation actions for each item.

Core Constraints

  • Do not execute tests, assume missing rules, versions, thresholds, data, or responses, or treat candidate counts as coverage proof.
  • File presence, names, design declarations, and Eval configuration are not runtime evidence.
  • Mark unknowns unassessed, blocked, or pending clarification instead of filling them with convention.
  • Do not edit requirements, code, test assets, or target systems.

Pre-delivery Check

  • Recorded the known, missing, conflicting, stale, out_of_scope, and assumptions input audit.
  • Every ASV-## has source, evidence state, impact/priority, owner role, close condition, and validation.
  • Facts, inferences, recommendations, unexecuted work, and Human decisions remain separate.
  • Findings are not execution results, coverage proof, or release claims.

Reference Files

  • Read evals/eval.yaml and matching cases for regression; configuration does not prove project results.
  • Use evals/trigger-prompts.csv and evals/local-rules.json for trigger checks; missing skill.selection evidence is BLOCKED.

Common Pitfalls

  • Do not turn a method name, file presence, or candidate count into test execution, coverage, pass, or release evidence when scope or evidence is incomplete.
  • Do not fill in missing rules, thresholds, data, environments, or results from convention; preserve unassessed, blocked, and pending items.
  • Do not expand this specialist design or review into a complete strategy, full test cases, runtime execution, or a release decision.

Best Practices

  • Complete the six-part input audit before selecting the smallest traceable and verifiable finding scope.
  • Keep the source, evidence state, impact/priority, owner role, close condition, validation method, and residual risk for every finding.
  • Write validation suggestions as next actions; do not upgrade package structure, candidate counts, or local Eval configuration into real quality conclusions.

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 Schema Validation AI skill do?

Use this skill when you need to compare API schemas with sourced request and response evidence; triggers include API Schema 校验 and API schema validation.

Why use Api Schema Validation on TypingMind?

Because you install it once and use it with any model. Api Schema Validation 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 Schema Validation in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-schema-validation. 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 Schema Validation?

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 Schema Validation?

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

Is the Api Schema Validation AI skill free?

It is published on GitHub by naodeng. Check the repository for licensing terms. 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 👇