AGENT SKILL

api-context-spec

Use when generating or maintaining OpenAPI specs as context for AI agents. Ensures API contracts are explicit, versioned, and machine-readable.

License 许可
MIT
最近更新
2026-11-15
Stars
★ 0
Forks
1

01 前言 Front Matter

name
api-context-spec
triggers
[ "user", "model" ]
description
Use when generating or maintaining OpenAPI specs as context for AI agents. Ensures API contracts are explicit, versioned, and machine-readable.

03 SKILL.md 正文

API Context Spec

Generates and maintains OpenAPI specs as context for AI agents. Ensures API contracts are explicit, versioned, and machine-readable so agents can reason about endpoints without reading implementation code.

When to use

  • When designing or reviewing an API.
  • When the API contract is not documented or is outdated.
  • When an AI agent needs to understand the API surface without reading code.
  • When generating client SDKs or contract tests.

What to include

  1. Endpoints. Paths, methods, parameters, request/response schemas.
  2. Authentication. Auth type, required headers, token format.
  3. Error responses. Status codes, error schemas, retry semantics.
  4. Versioning. API version, deprecation policy, migration path.
  5. Rate limits. Requests per second, burst limits, backoff strategy.

Process

Design or review API
  → Generate or update OpenAPI spec
  → Validate spec against implementation
  → Use spec as context for AI agents
  → Keep spec in version control

Example

openapi: 3.0.0
info:
  title: User API
  version: 1.0.0
paths:
  /users/{id}:
    get:
      summary: Get user by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: User found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found

Anti-patterns

  • No API spec or an outdated spec.
  • Spec written in prose instead of OpenAPI.
  • Spec not versioned or not in version control.
  • Agents reading implementation code instead of the spec.

Cross-skills

  • api-design - designs the API that this spec documents.
  • planning-pipeline - uses the spec as context for tickets.
  • implement - uses the spec as the contract to implement.
  • verification-before-completion - verifies the spec is up to date.

04 同仓库更多 Skills

Leostruka
Leostruka/devin-bundle

montador-de-ideias

Use when assembling, expanding, or elevating a raw project idea or initial prompt into an ultra-detailed, first-principles dossier and compiled master prompt with journalistic OSINT market research, Tech Lead and Staff Architect justifications, atomic and modular hardening/optimization, and high-impact contact surfaces.

★ 0
Leostruka
Leostruka/devin-bundle

git-github-adaptive-engineering

Use when any task touches git history, GitHub issues/PRs/releases/CI, repo governance, or branch and merge decisions. Runs the Fase Zero situational-awareness battery, picks one of five delivery flows via the adaptive decision engine, and enforces commit/PR information-density standards. Orchestrates the gh, git-workflows, github-actions, pr, and debug/finish skills.

★ 0
Leostruka
Leostruka/devin-bundle

adaptive-agenda-calendar-routine-engine

Use when planning or executing work across hours, days, weeks, or sprints. Turns the calendar into a strict time-blocked agenda (HH:MM-HH:MM blocks carrying a routine profile, expected inputs, and a handoff output artifact), runs the 5-stage cognitive flow (Radar and Hunt -> Triage plus Steve Jobs conception -> workbench manifest -> >=32-cycle loop -> Close plus Open-Minded Scrum), and unfolds macro calendar milestones into micro agenda blocks through extensions/gcal/wrapper.py.

★ 0
Leostruka
Leostruka/devin-bundle

demo

Use when demonstrating a skill in a fixture project.

★ 0
Leostruka
Leostruka/devin-bundle

duplicate-skill

Use when testing duplicate skill name detection.

★ 0
Leostruka
Leostruka/devin-bundle

duplicate-skill

Use when testing duplicate skill name detection.

★ 0