MCPInstall

ln-775-api-docs-generator

by levnikolaevichBackend & APIs

Configures Swagger/OpenAPI documentation for backend APIs. Use when adding interactive API docs to a project.

Installs
432
Last 24h
—
Trending rank
—
Security
Not audited

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-775-api-docs-generator
  1. 01

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads ln-775-api-docs-generator automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

SKILL.md

The instructions your agent reads when the skill is triggered.

ln-775-api-docs-generator

Type: L3 Worker Category: 7XX Project Bootstrap

Configures API documentation with Swagger/OpenAPI.

Overview

AspectDetails
InputContext Store from ln-770
OutputSwagger/OpenAPI configuration
Stacks.NET (Swashbuckle), Python (FastAPI built-in)

Phase 1: Receive Context + Analyze API Structure

Accept Context Store and scan for API endpoints.

Required Context:

  • STACK: .NET or Python
  • PROJECT_ROOT: Project directory path

Idempotency Check:

  • .NET: Grep for AddSwaggerGen or UseSwagger
  • Python: FastAPI has built-in OpenAPI, check for custom configuration
  • If found: Return { "status": "skipped" }

API Analysis:

  1. Scan for controller/router files
  2. Identify authentication method (JWT, OAuth2, API Key)
  3. Check for API versioning

Phase 2: Research Documentation Standards

Use MCP tools for current documentation.

For .NET:

MCP ref: "Swashbuckle ASP.NET Core OpenAPI Swagger configuration"
Context7: /domaindrivendev/Swashbuckle.AspNetCore

For Python:

MCP ref: "FastAPI OpenAPI documentation customization"
Context7: /tiangolo/fastapi

Key Patterns to Research:

  1. OpenAPI 3.0/3.1 specification
  2. Security scheme definitions
  3. XML comments integration (.NET)
  4. Response examples and schemas
  5. API versioning documentation

Phase 3: Decision Points

Q1: API Information

FieldDescriptionRequired
TitleAPI name✓ Yes
VersionAPI version (v1, v2)✓ Yes
DescriptionBrief descriptionOptional
ContactSupport contactOptional
LicenseAPI licenseOptional

Q2: Security Scheme

SchemeUse CaseOpenAPI Type
JWT Bearer (Recommended)Token in Authorization headerhttp + bearer
API KeyKey in header or queryapiKey
OAuth2Full OAuth2 flowoauth2
NonePublic APINo security

Q3: Documentation Features

Feature.NETPythonDefault
XML Comments✓ SupportedN/A✓ Enable
Response Examples✓ Manual✓ Pydantic✓ Enable
Request Validation✓ Annotations✓ Pydantic✓ Enable
Try It Out✓ Yes✓ Yes✓ Enable

Phase 4: Generate Configuration

.NET Output Files

FilePurpose
Extensions/SwaggerExtensions.csSwagger service registration
*.csproj (update)Enable XML documentation

Generation Process:

  1. Use MCP ref for current Swashbuckle API
  2. Generate SwaggerExtensions with:
    • AddEndpointsApiExplorer
    • AddSwaggerGen with OpenApiInfo
    • Security definition (if auth detected)
    • XML comments inclusion
  3. Update csproj for documentation generation

Packages to Add:

  • Swashbuckle.AspNetCore

Registration Code:

builder.Services.AddSwaggerServices();
// ...
app.UseSwaggerServices();

csproj Update:

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>

Python Output Files

FilePurpose
core/openapi_config.pyOpenAPI customization

Generation Process:

  1. Use MCP ref for FastAPI OpenAPI customization
  2. Generate openapi_config.py with:
    • Custom OpenAPI schema
    • Security scheme definitions
    • Tags and descriptions
  3. FastAPI generates OpenAPI automatically

Note: FastAPI has built-in OpenAPI support. This worker customizes the default configuration.

Registration Code:

from core.openapi_config import custom_openapi
app.openapi = lambda: custom_openapi(app)

Phase 5: Validate

Validation Steps:

  1. Syntax check:

    • .NET: dotnet build --no-restore
    • Python: python -m py_compile core/openapi_config.py

  2. Access documentation:

    StackURL
    .NEThttp://localhost:5000/swagger
    Pythonhttp://localhost:5000/docs
    Python (ReDoc)http://localhost:5000/redoc

  3. Verify content:

    • All endpoints visible
    • Request/response schemas displayed
    • Security scheme shown (if configured)
    • Try It Out functional

  4. OpenAPI spec validation:

    # .NET
curl http://localhost:5000/swagger/v1/swagger.json | jq .

# Python
curl http://localhost:5000/openapi.json | jq .

Security Scheme Examples

JWT Bearer (.NET)

// Structure only - actual code generated via MCP ref
options.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
{
    Description = "JWT Authorization header using Bearer scheme",
    Name = "Authorization",
    In = ParameterLocation.Header,
    Type = SecuritySchemeType.Http,
    Scheme = "bearer",
    BearerFormat = "JWT"
});

JWT Bearer (Python/FastAPI)

# Structure only - actual code generated via MCP ref
from fastapi.security import HTTPBearer
security = HTTPBearer()

Return to Coordinator

{
  "status": "success",
  "files_created": [
    "Extensions/SwaggerExtensions.cs"
  ],
  "packages_added": [
    "Swashbuckle.AspNetCore"
  ],
  "registration_code": "builder.Services.AddSwaggerServices();",
  "message": "Configured Swagger/OpenAPI documentation"
}

Reference Links

Critical Rules

  • Use MCP ref for current Swashbuckle/FastAPI API — do not hardcode configuration from memory
  • Auto-detect auth scheme — scan for JWT, OAuth2, or API Key and configure security definition accordingly
  • Enable XML documentation in .NET — update csproj with GenerateDocumentationFile and suppress warning 1591
  • FastAPI: customize, not replace — built-in OpenAPI works by default, only add custom schema/security
  • Idempotent — if AddSwaggerGen/UseSwagger exists, return status: "skipped"

Definition of Done

  • Context Store received (stack, project root)
  • API structure analyzed (controllers/routers, auth method, versioning)
  • Documentation standards researched via MCP tools
  • Swagger/OpenAPI configuration generated with API info and security scheme
  • XML comments enabled (.NET) or custom OpenAPI schema configured (Python)
  • Syntax validated (dotnet build or py_compile)
  • Structured JSON response returned to ln-770 coordinator

Version: 2.0.0 Last Updated: 2026-01-10

FAQ

What does the ln-775-api-docs-generator skill do?

Configures Swagger/OpenAPI documentation for backend APIs. Use when adding interactive API docs to a project.

How do I install ln-775-api-docs-generator?

Run npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-775-api-docs-generator in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/ln-775-api-docs-generator/ (personal) or .claude/skills/ln-775-api-docs-generator/ (project).

Which AI agents can use ln-775-api-docs-generator?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is ln-775-api-docs-generator safe to install?

No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.

Who maintains ln-775-api-docs-generator?

It is published by levnikolaevich in levnikolaevich/claude-code-skills. It has 432 recorded installs.

More from levnikolaevich/claude-code-skills

View all →

ln-100-documents-pipeline

levnikolaevich/claude-code-skills

Creates complete project documentation system (project docs, reference, tasks, tests). Use when bootstrapping docs from scratch or regenerating all.

Docs & Writing479 installs

ln-620-codebase-auditor

levnikolaevich/claude-code-skills

Open the skill to read its SKILL.md instructions.

Code Quality & Workflow449 installs

ln-624-code-quality-auditor

levnikolaevich/claude-code-skills

Open the skill to read its SKILL.md instructions.

413 installs

ln-782-test-runner

levnikolaevich/claude-code-skills

Open the skill to read its SKILL.md instructions.

Testing & QA412 installs

ln-634-test-coverage-auditor

levnikolaevich/claude-code-skills

Open the skill to read its SKILL.md instructions.

Testing & QA401 installs

ln-201-opportunity-discoverer

levnikolaevich/claude-code-skills

Open the skill to read its SKILL.md instructions.

398 installs

Popular backend & apis skills

View category →

find-skills

vercel-labs/skills

Helps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skill should be used when the user is looking for functionality that might exist as an installable skill.

OfficialBackend & APIs4.1M installs

entra-app-registration

microsoft/azure-skills

Guides Microsoft Entra ID app registration, OAuth 2.0 authentication, and MSAL integration. USE FOR: create app registration, register Azure AD app, configure OAuth, set up authentication, add API permissions, generate service principal, MSAL example, console app auth, Entra ID setup, Azure AD authentication. DO NOT USE FOR: Key Vault secrets (use azure-keyvault-expiration-audit), general Azure resource security guidance.

OfficialBackend & APIs566.7K installs

google-agents-cli-adk-code

google/agents-cli

This skill should be used when the user wants to "write agent code", "build an agent with ADK", "add a tool", "create a callback", "define an agent", "use state management" — in a project that needs ADK (Agent Development Kit) API patterns and code examples. It provides a quick reference for agent types, tool definitions, orchestration patterns, callbacks, state management, the graph Workflow API, and reference recipes to study. Do NOT use for scaffolding (use google-agents-cli-scaffold) or deployment (use google-agents-cli-deploy).

Backend & APIs514.8K installs

embedded-captions

heygen-com/hyperframes

Add captions or subtitles to an existing single-subject talking-head video without editing the footage. Use for plain verbatim captions, cinematic captions embedded behind the subject, VFX captions, “炸/特效/酷炫字幕,” or a named identity from the 35-style catalog. Route by visual identity, not by backend engine. The quiet anchor rail is the default; embed every word only when the user explicitly wants a fully cinematic treatment. The workflow runs locally end to end, including transcription and subject matting; split multi-shot footage before applying it.

Backend & APIs453.3K installs

entra-agent-id

microsoft/azure-skills

Provision Microsoft Entra Agent Identity Blueprints, BlueprintPrincipals, and per-instance Agent Identities via Microsoft Graph, and configure OAuth 2.0 token exchange (fmipath, OBO, cross-tenant) including the Microsoft Entra SDK for AgentID sidecar. USE FOR: Agent Identity Blueprint, BlueprintPrincipal, agent OAuth, fmipath token exchange, agent OBO, Workload Identity Federation for agents, polyglot agent auth, Microsoft.Identity.Web.AgentIdentities. DO NOT USE FOR: standard Entra app registration (use entra-app-registration), Microsoft Foundry agent authoring (use microsoft-foundry).

OfficialBackend & APIs336.6K installs

neon

neondatabase/agent-skills

Overview of Neon, a complete set of cloud backend primitives around Lakebase Postgres: Auth, Object Storage, Functions, the AI Gateway, and Realtime. Start here to choose Neon for undecided login, files, APIs, and LLM calls, set up the CLI or MCP server, and follow the branch-first workflow. Use when building an app or backend on Neon, or when "Neon" or "Lakebase Postgres" is mentioned. Child skill neon-postgres wins for an existing DATABASEURL, SQL, schema, inspect, or search. Child skill neon-auth wins for login, users, sessions, identity routing, and Managed Better Auth setup. Child skill neon-realtime wins for live queries in reactive apps and agents. Also use for object storage, S3, buckets, serverless functions, function triggers, cron, AI gateway, LLM calls, realtime, logs, Loki, Grafana, observability, postgres, database, backend, Claimable Neon, neon.new, or a no-signup database.

Backend & APIs237.1K installs