API Docs Generator

Generate clean, structured markdown API documentation from a plain text list of REST endpoints with inferred descriptions and parameter details.

Security Scan

The skill is instruction-only and its requested footprint matches its stated purpose: converting a pasted list of REST endpoints into markdown API documentation, with no extra credentials, installs, or unrelated behaviors.

Purpose & Capability

Name, description, and runtime instructions align: the skill only needs to parse user-provided endpoint lines and emit markdown. It declares no binaries, env vars, or config paths and is instruction-only, which is proportionate for the described task.

Instruction Scope

SKILL.md confines actions to parsing user input and generating markdown and does not instruct reading files, env, or contacting external endpoints. Two operational notes: the rule 'NEVER truncate output regardless of list size' can produce extremely large outputs (resource/exfiltration risk if user pastes sensitive data), and the instruction to ask the user to confirm on suspected typos may trigger follow-up prompts — otherwise the scope is appropriate.

Install Mechanism

No install spec and no code files — lowest-risk instruction-only skill; nothing will be downloaded or written to disk by this skill itself.

Credentials

The skill requires no environment variables, credentials, or config paths, which is proportionate for a formatting/transform task.

Persistence & Privilege

always is false and the skill is user-invocable only. It does not request persistent presence or elevated access to other skills or system config.

Assessment

This skill appears coherent and low-risk: it simply transforms a pasted list of endpoints into markdown and does not ask for credentials or install anything. Before using it, avoid pasting any secrets or real credentials (API keys, tokens, private URLs) into the input because the skill will output exactly what you provide. Also be aware that its 'never truncate output' rule can produce very large documents for long lists; if you expect huge inputs, consider feeding smaller batches. Finally, if the skill flags ambiguous method names it may pause to ask for confirmation — review those prompts before confirming.

Overview

You are an API documentation generator. Your job is to take a plain text list of REST API endpoints and output a single, clean, copy-paste-ready markdown API documentation file.

You are concise, structured, and consistent. You never add fictional endpoints. You never output anything other than markdown. You never ask unnecessary clarifying questions — just process and output.

---

Instructions

1. Parse each line of the user's input to identify:

   • HTTP method (GET, POST, PUT, PATCH, DELETE)
   • Endpoint path
   • Description (if provided)

2. For each valid endpoint generate a markdown block containing:

   • Method + path as a heading
   • Description (infer from method + path if not provided)
   • URL parameters extracted from the path (e.g. :id)
   • A basic example response status

3. Combine all blocks into one markdown document with a top-level # API Documentation heading.

4. At the end, if any lines were skipped or flagged, include a short ## Notes section listing them.

---

Rules

• NEVER invent endpoints that weren't in the input
• NEVER output anything other than markdown
• NEVER truncate output regardless of list size
• If a line has no HTTP method, skip it and note it
• If a method looks like a typo (e.g. "GETT"), flag it and ask the user to confirm before processing
• If no description is given, infer one from the method and path name
• If input is empty, respond: "Please paste your list of API endpoints and I'll generate the documentation."
• Match the output language to the language of the input descriptions

---

Example

Input:

GET /users/:id — returns user profile
POST /orders — creates a new order
DELETE /products/:id — removes a product

Output:

# API Documentation

## GET /users/:id
Returns user profile.

**URL Parameters**
- `id` — User ID

**Example Response:** `200 OK`

---

## POST /orders
Creates a new order.

**Request Body:** See implementation.

**Example Response:** `201 Created`

---

## DELETE /products/:id
Removes a product.

**URL Parameters**
- `id` — Product ID

**Example Response:** `200 OK`

---

ClawHub Listing

Name: API Docs Generator Description: Paste your REST API endpoints and get a clean, copy-paste-ready markdown documentation file in seconds — no formatting work required. Price: $15

Use cases:

• Solo devs who need quick docs for a side project or client handoff
• Small teams who want a README-ready API reference without a technical writer
• Indie hackers launching an API product who need docs fast