prompt

API Docs Writer

Writes clear reference docs for an API endpoint.

VettedUpdated June 2026

The prompt

You are a technical writer.
Write reference documentation for this endpoint: {{endpoint}}

Details: {{details}}.
Output: a one-line summary, method and path, parameters (name, type, required, description), an example request, an example response, and common error codes. Keep it scannable.
Rules: match the given details exactly; do not invent fields.

Did it work? Rate this prompt

Variables

{{endpoint}}Endpoint name

{{details}}Endpoint details

Example output

Summary: create a new order. POST /v1/orders Params: customer_id (string, required), items (array, required), note (string, optional). Request: {"customer_id":"c_12","items":[{"sku":"A1","qty":2}]} Response 201: {"id":"o_88","status":"created"} Errors: 400 invalid items, 404 customer not found.

Details

Author

AI Khazna

License

—

Security

Vetted

Type

prompt

Related assets

More curated picks in Development & Code.

mcp serverclaude_codecursorcodex

npm install @modelcontextprotocol/server-everything

Everything

Reference / test server that exercises all features of the MCP protocol — prompts, resources, tools.★ 4.9 · 5,000+

mcp serverclaude_codecursorcodex

npm install @modelcontextprotocol/server-memory

Memory

Knowledge graph-based persistent memory system. Lets agents remember facts across conversations.★ 4.9 · 5,000+

mcp serverclaude_codecursorcodex

npm install @modelcontextprotocol/server-filesystem

Filesystem

Secure file operations with configurable access controls. Read, write, list, and search local files.★ 4.9 · 5,000+

mcp serverclaude_codecursorcodex

npm install @modelcontextprotocol/server-git

Git

Tools to read, search, and manipulate Git repositories — log, diff, blame, branches, and more.★ 4.9 · 5,000+

mcp serverclaude_codecursorcodex

npm install @modelcontextprotocol/server-fetch

Fetch

Web content fetching and conversion server for efficient LLM usage. Retrieves and converts URLs to clean markdown.★ 4.9 · 5,000+

mcp serverclaude_codecursorcodex

npm install @modelcontextprotocol/server-sequentialthinking

Sequential Thinking

Dynamic problem-solving through structured thought sequences with branching, revision, and reflection.★ 4.9 · 5,000+

Audit before you install

Run any source through our checks - AI visibility, security, performance, and stack detection.

Automated Web Security Scan

security

PageSpeed Analyzer

performance

AI Content Quality Test

arabic content

AI Agent / MCP Server Tester

ai testing

Site Stack Detector

migration

AI SEO / AEO / GEO Audit

ai visibility

llms.txt Generator

ai visibility

Readability Score

arabic content

Schema / JSON-LD Builder

ai visibility

AI Cost Calculator

ai testing

Headline Analyzer

arabic content