shadow-api
Skill1 starsChanged yesterdayMITView on GitHub
Backend API & Contract Sync. Use when creating, modifying, or testing HTTP/REST API endpoints, generating or validating OpenAPI 3.1 (openapi.yaml), or syncing Postman collections via shadow_api MCP.
In this repository51 other files it gives its agents.
- antislop-codeSkill
- antislop-copywritingSkill
- antislop-humanSkill
- antislop-layoutmobileSkill
- antislopSkill
- antislop-uiSkill
- context7Skill
- handoffSkill
- shadow-accessibilitySkill
- shadow-architectSkill
- shadow-authSkill
- shadow-bootstrapSkill
- shadow-browserSkill
- shadow-cacheSkill
- shadow-compatSkill
- shadow-concurrencySkill
- shadow-dataSkill
- shadow-dbSkill
- shadow-debugSkill
- shadow-designSkill
- shadow-discoverySkill
- shadow-docSkill
- shadow-domainSkill
- shadow-eaSkill
- shadow-evalSkill
- shadow-finopsSkill
- shadow-gitSkill
- shadow-grcSkill
- shadow-handoverSkill
- shadow-integrateSkill
- shadow-maintainSkill
- shadow-mobileSkill
- shadow-modernizeSkill
- shadow-monarchSkill
- shadow-observeSkill
- shadow-opsSkill
- shadow-perfSkill
- shadow-planSkill
- shadow-pmoSkill
- shadow-presalesSkill
- shadow-privacySkill
- shadow-qualitySkill
- shadow-realtimeSkill
- shadow-refactorSkill
- shadow-releaseSkill
- shadow-resilienceSkill
- shadow-searchSkill
- shadow-secSkill
- shadow-supplychainSkill
- shadow-testSkill
- shadow-uatSkill
The file
We split this skill into the rules it gives an agent
7 rules. About 0 are common, 1 is distinctive, and 6 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 8
Use this skill whenever the Monarch invokes /shadow-api, asks to generate OpenAPI/Postman from an existing backend, or builds/updates …
- Very specific: line 15
Call bulk_upsert_openapi_endpoints in a single batch call with specPath: "<project>/docs/api/openapi.yaml", autoSyncPostman: true, and the …
- Very specific: line 18
When adding or modifying 1–2 endpoints during development, call upsert_openapi_endpoint followed by sync_postman_collection.
- Distinctive: line 20
Ensure zero missing summaries or responses.
- Very specific: line 22
When the local/staging backend server is running, fire real HTTP requests to verify status codes, latency (ms), and response payloads, …
- Very specific: line 24
Standard Error Envelope: Use structured application/problem+json (RFC 9457: type, title, status, detail, instance / errors[]) without …
- Very specific: line 26
Evolution & Negative Testing: Document breaking vs additive changes (/shadow-compat), emit Deprecation/Sunset headers before removing …
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
/shadow-api — Real API Tester, OpenAPI 3.1 & Postman Sync (Shadow Army)
Use this skill whenever the Monarch invokes /shadow-api, asks to generate OpenAPI/Postman from an existing backend, or builds/updates backend API endpoints.
This skill connects directly to the shadow_api MCP server (test_api_endpoint, upsert_openapi_endpoint, bulk_upsert_openapi_endpoints, validate_openapi_spec, sync_postman_collection, run_api_collection).
Workflow
- Generate OpenAPI + Postman from an Existing Backend (
bulk_upsert_openapi_endpoints):- Scout the existing backend routes, controllers, validators (Zod/Joi/class-validator/Pydantic/Go structs), and response DTOs.
- Call
bulk_upsert_openapi_endpointsin a single batch call withspecPath: "<project>/docs/api/openapi.yaml",autoSyncPostman: true, and the fullendpointsarray. - Automatically selects Compact Mode (
docs/api/openapi.yaml) for small projects (≤ 4 modules) or Modular Mode (docs/api/modules/<module>.openapi.yaml+ bundleddocs/api/openapi.yaml+ nested Postman folders) for multi-module projects.
- Single Endpoint Upsert (
upsert_openapi_endpoint):- When adding or modifying 1–2 endpoints during development, call
upsert_openapi_endpointfollowed bysync_postman_collection.
- When adding or modifying 1–2 endpoints during development, call
- Validate OpenAPI (
validate_openapi_spec):- Ensure zero missing summaries or responses.
- Live HTTP Verification (
test_api_endpoint/run_api_collection):- When the local/staging backend server is running, fire real HTTP requests to verify status codes, latency (
ms), and response payloads, recording real responses directly into OpenAPI.
- When the local/staging backend server is running, fire real HTTP requests to verify status codes, latency (
- Contract-First, RFC 9457 Errors, Idempotency & Pagination Discipline:
- Standard Error Envelope: Use structured
application/problem+json(RFC 9457:type,title,status,detail,instance/errors[]) without leaking stack traces or internal SQL errors. - Idempotency & Pagination: Enforce
Idempotency-Keysemantics on non-idempotent payment/orderPOSTroutes (/shadow-concurrency//shadow-cache); enforce bounded cursor (seek/ keyset) or validated offset pagination (limit <= 100) with stable sort keys (tie-broken byid). - Evolution & Negative Testing: Document breaking vs additive changes (
/shadow-compat), emitDeprecation/Sunsetheaders before removing fields, and test invalid payloads (400/422), unauthorized (401/403), and conflicts (409).
- Standard Error Envelope: Use structured
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

