How do I install the API Contract Init skill?

Run npx skillmds@latest add aibot88/api-contract-init in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the API Contract Init skill do?

Generate API_CONTRACT.md by scanning existing routes and controllers It is listed under Integrations & APIs on SkillMD.

Is API Contract Init safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with API Contract Init?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is API Contract Init free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published API Contract Init?

aibot88 (@aibot88) published this skill. Their other Agent Skills are listed on their SkillMD profile.

API Contract Init by aibot88 — Agent Skill

Name: API Contract Init
Rating: 4.5 (4 reviews)
Author: aibot88

File contents

Generate an API_CONTRACT.md by scanning the real codebase. Never fabricate endpoints or types.

1. Detect the backend stack

File	Stack
`package.json` with `@nestjs/core`	NestJS
`package.json` with `express`/`fastify`	Express/Fastify
`composer.json`	CakePHP / Laravel
`pyproject.toml` or `requirements.txt` with `django`/`fastapi`/`flask`	Python
`go.mod`	Go
`Cargo.toml` with `actix`/`axum`/`rocket`	Rust
`Gemfile` with `rails`	Rails

2. Scan routes and controllers

Stack	Where to look
NestJS	`*.controller.ts` — decorators `@Get`, `@Post`, `@Put`, `@Delete`, `@Patch`
Express/Fastify	`routes/`, `router/` — `router.get()`, `app.post()`, etc.
CakePHP/Laravel	`Controller.php` — public methods, `routes/.php`
Django	`urls.py` — `urlpatterns`, `ViewSet` classes
FastAPI	`*.py` — `@app.get`, `@router.post`, etc.
Go	`_handler.go`, `_router.go` — `HandleFunc`, `mux.Handle`
Rails	`config/routes.rb` — resources, get/post/put/delete
Rust	`routes/*.rs` — handler functions, route macros

3. For each endpoint, extract

HTTP method and path
Request body / query params (from DTOs, structs, dataclasses, type annotations)
Response type (if detectable)
Auth requirement (if detectable)
If a type cannot be determined, write // TODO: define type — NEVER fabricate

4. Generate the contract

Use this format:

# API Contract — [Project Name]

Source of truth for backend/frontend communication.

## Global Conventions
- Base URL: [detected or TODO]
- Auth: [detected or TODO]
- Response format: [detected or standard JSON]
- Error format: [detected or TODO]

## [Domain — grouped by controller/router]

### [METHOD] [path]

**Request:**
\`\`\`[lang]
[body type / query params]
\`\`\`

**Response:**
\`\`\`[lang]
[response type]
\`\`\`

**Auth:** [required/optional/none]
**Notes:** [if applicable]

---

## Changelog

| Date | Change | Side |
|------|--------|------|
| [today] | Initial generation from code | backend |

5. Placement

If argument is shared or no argument: propose shared/API_CONTRACT.md
If argument is root: propose API_CONTRACT.md at project root

Present the generated contract and wait for user validation before writing.

---name: api-contract-initdescription: Generate API_CONTRACT.md by scanning existing routes and controllers--- Generate an `API_CONTRACT.md` by scanning the **real** codebase. Never fabricate endpoints or types. ## 1. Detect the backend stack | File | Stack | |---|---| | `package.json` with `@nestjs/core` | NestJS | | `package.json` with `express`/`fastify` | Express/Fastify | | `composer.json` | CakePHP / Laravel | | `pyproject.toml` or `requirements.txt` with `django`/`fastapi`/`flask` | Python | | `go.mod` | Go | | `Cargo.toml` with `actix`/`axum`/`rocket` | Rust | | `Gemfile` with `rails` | Rails | ## 2. Scan routes and controllers | Stack | Where to look | |---|---| | NestJS | `*.controller.ts` — decorators `@Get`, `@Post`, `@Put`, `@Delete`, `@Patch` | | Express/Fastify | `routes/**`, `router/**` — `router.get()`, `app.post()`, etc. | | CakePHP/Laravel | `*Controller.php` — public methods, `routes/*.php` | | Django | `urls.py` — `urlpatterns`, `ViewSet` classes | | FastAPI | `*.py` — `@app.get`, `@router.post`, etc. | | Go | `*_handler.go`, `*_router.go` — `HandleFunc`, `mux.Handle` | | Rails | `config/routes.rb` — resources, get/post/put/delete | | Rust | `routes/*.rs` — handler functions, route macros | ## 3. For each endpoint, extract - HTTP method and path - Request body / query params (from DTOs, structs, dataclasses, type annotations) - Response type (if detectable) - Auth requirement (if detectable) - If a type cannot be determined, write `// TODO: define type` — **NEVER fabricate** ## 4. Generate the contract Use this format: ```markdown # API Contract — [Project Name] Source of truth for backend/frontend communication. ## Global Conventions - Base URL: [detected or TODO] - Auth: [detected or TODO] - Response format: [detected or standard JSON] - Error format: [detected or TODO] ## [Domain — grouped by controller/router] ### [METHOD] [path] **Request:** \`\`\`[lang] [body type / query params] \`\`\` **Response:** \`\`\`[lang] [response type] \`\`\` **Auth:** [required/optional/none] **Notes:** [if applicable] --- ## Changelog | Date | Change | Side | |------|--------|------| | [today] | Initial generation from code | backend | ``` ## 5. Placement - If argument is `shared` or no argument: propose `shared/API_CONTRACT.md` - If argument is `root`: propose `API_CONTRACT.md` at project root **Present the generated contract and wait for user validation before writing.**

Frequently asked questions

API Contract Init