Official agent skill

API Docs

by langchain-ai in langchain-ai/skills-benchmarks

OpenAPI documentation and REST API design patterns. An agent skill from langchain-ai/skills-benchmarks.

OfficialMITAuto-check passedDevelopment

Install API Docs

skills CLI

$ npx skills add langchain-ai/skills-benchmarks --skill api-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install langchain-ai/skills-benchmarks api-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/langchain-ai/skills-benchmarks.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/noise/api_docs .claude/skills/api-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "api-docs" agent skill from https://github.com/langchain-ai/skills-benchmarks/tree/main/skills/noise/api_docs into .claude/skills/api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docs", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/langchain-ai/skills-benchmarks/tree/main/skills/noise/api_docs

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add langchain-ai/skills-benchmarks --skill api-docs -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install langchain-ai/skills-benchmarks api-docs --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/langchain-ai/skills-benchmarks.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/noise/api_docs .agents/skills/api-docs && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "api-docs" agent skill from https://github.com/langchain-ai/skills-benchmarks/tree/main/skills/noise/api_docs into .agents/skills/api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docs", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add langchain-ai/skills-benchmarks --skill api-docs -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install langchain-ai/skills-benchmarks api-docs --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/langchain-ai/skills-benchmarks.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/noise/api_docs .cursor/skills/api-docs && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "api-docs" agent skill from https://github.com/langchain-ai/skills-benchmarks/tree/main/skills/noise/api_docs into .cursor/skills/api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docs", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/langchain-ai/skills-benchmarks.git --path skills/noise/api_docs

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add langchain-ai/skills-benchmarks --skill api-docs -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install langchain-ai/skills-benchmarks api-docs --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/langchain-ai/skills-benchmarks.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/noise/api_docs .gemini/skills/api-docs && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "api-docs" agent skill from https://github.com/langchain-ai/skills-benchmarks/tree/main/skills/noise/api_docs into .gemini/skills/api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docs", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install langchain-ai/skills-benchmarks api-docs

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add langchain-ai/skills-benchmarks --skill api-docs -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/langchain-ai/skills-benchmarks.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/noise/api_docs .github/skills/api-docs && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "api-docs" agent skill from https://github.com/langchain-ai/skills-benchmarks/tree/main/skills/noise/api_docs into .github/skills/api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docs", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add langchain-ai/skills-benchmarks --skill api-docs -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install langchain-ai/skills-benchmarks api-docs --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/langchain-ai/skills-benchmarks.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/noise/api_docs .opencode/skills/api-docs && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "api-docs" agent skill from https://github.com/langchain-ai/skills-benchmarks/tree/main/skills/noise/api_docs into .opencode/skills/api-docs/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "api-docs", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: api-docs
GitHub stars: 118
Token cost: ~358 tokens
SKILL.md length: 61 words
Files: 1
Skills in repo: 8
Repo updated: Sep 21, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

OpenAPI documentation and REST API design patterns. An agent skill from langchain-ai/skills-benchmarks.

Works in 5 steps: Use nouns for resources: /users, /orders → Use HTTP methods correctly: GET, POST,… → Return appropriate status codes: 200,… → …
Tasks that involve Technical documentation
SKILL.md covers OpenAPI Specification, REST Conventions and Error Responses
Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

API Docs is an agent skill from langchain-ai/skills-benchmarks, published by the product's own GitHub organization. OpenAPI documentation and REST API design patterns

Its SKILL.md is about 360 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation, OpenAPI specifications and Design patterns. It works with OpenAPI. The licence is MIT.

When your agent uses it

Tasks that involve Technical documentation
Tasks that involve OpenAPI specifications
Tasks that involve Design patterns

Example prompts

“/api-docs”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

Use nouns for resources: /users, /orders
Use HTTP methods correctly: GET, POST, PUT, PATCH, DELETE
Return appropriate status codes: 200, 201, 400, 404, 500
Use pagination for lists: ?page=1&limit=20
Version your API: /v1/users

What it can do on your machine

Read from SKILL.md and the folder at commit 9195f8c. It shows what the files ask for, not the result of running them.

Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md (its code samples are yaml and json).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

API Docs loads about 358 tokens when it runs. Until then it costs about 15 tokens; SKILL.md has 61 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it: ~15
When it runs · the whole SKILL.md, loaded when a task matches: ~358

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from langchain-ai/skills-benchmarks at commit 9195f8c, republished under its MIT licence (© langchain-ai). 61 words, ~358 tokens.

Download SKILL.mdSave it as .claude/skills/api-docs/SKILL.md (or your agent's skills folder).

name: api-docs
description: OpenAPI documentation and REST API design patterns

API Documentation Standards

Design and document RESTful APIs following industry standards.

OpenAPI Specification

Always document APIs using OpenAPI 3.0+:

yaml

openapi: 3.0.3
info:
  title: User API
  version: 1.0.0

paths:
  /users:
    get:
      summary: List users
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'

components:
  schemas:
    User:
      type: object
      required: [id, email]
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email

REST Conventions

Use nouns for resources: /users, /orders
Use HTTP methods correctly: GET, POST, PUT, PATCH, DELETE
Return appropriate status codes: 200, 201, 400, 404, 500
Use pagination for lists: ?page=1&limit=20
Version your API: /v1/users

Error Responses

json

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid input",
    "details": [
      {"field": "email", "message": "Invalid email format"}
    ]
  }
}

Files

Just SKILL.md in skills/noise/api_docs of langchain-ai/skills-benchmarks.

Open the folder on GitHubat commit 9195f8c

Compare with similar skills

API Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Docs compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
API Docs this skilllangchain-ai/skills-benchmarks	118	—	~358	Automated safety check: Pass	MIT	16 days ago
OpenAPI Spec Generationwshobson/agents	40k	10 repos	~511	Automated safety check: Pass	MIT	3 days ago
API Documentation WriterOneWave-AI/claude-skills	323	—	~541	Automated safety check: Pass	MIT	6 days ago
API Documenteralirezarezvani/claude-code-tresor	777	—	~1.5k	Automated safety check: Pass	MIT	3 mo ago
API Contract Designrsmdt/the-startup	551	—	~1.1k	Automated safety check: Pass	MIT	2 mo ago
Python Fastapi Patternsaiskillstore/marketplace	430	1 repos	~1.3k	Automated safety check: Notes	None	yesterday

Similar skills

OpenAPI Spec Generation
wshobson/agents
Create, validate and maintain OpenAPI 3.1 specs for REST APIs, whether designed first or generated from existing code, and use them for docs and client SDKs.
40k GitHub starsUsed in 10 repos~511 tokens
Backend & APIsAuto-check passed
API Documentation Writer
OneWave-AI/claude-skills
Generate comprehensive API documentation including endpoint descriptions, request/response examples, authentication guides, error codes, and SDKs.
323 GitHub stars~541 tokensUpdated 6 days ago
Backend & APIsAuto-check passed
API Documenter
alirezarezvani/claude-code-tresor
Auto-generate API documentation from code and comments. An agent skill from alirezarezvani/claude-code-tresor.
777 GitHub stars~1.5k tokensUpdated 3 mo ago
Backend & APIsAuto-check passed
API Contract Design
rsmdt/the-startup
REST and GraphQL API design patterns, OpenAPI/Swagger specifications, versioning strategies, and authentication patterns.
551 GitHub stars~1.1k tokensUpdated 2 mo ago
Backend & APIsAuto-check passed
Python Fastapi Patterns
aiskillstore/marketplace
FastAPI web framework patterns. An agent skill from aiskillstore/marketplace.
430 GitHub starsUsed in 1 repo~1.3k tokens
Backend & APIsAuto-check: notes
Document API Endpoint
getsentry/skills
Official
Document and type a Sentry API endpoint. An agent skill from getsentry/skills.
1k GitHub stars~1.1k tokensUpdated 5 days ago
Backend & APIsAuto-check passed

Questions about API Docs

What does API Docs do?

OpenAPI documentation and REST API design patterns. An agent skill from langchain-ai/skills-benchmarks. API Docs is an agent skill from langchain-ai/skills-benchmarks, published by the product's own GitHub organization.

When should I use API Docs?

API Docs fits situations like: tasks that involve Technical documentation; tasks that involve OpenAPI specifications; tasks that involve Design patterns.

How do I install API Docs in Claude Code?

Run `npx skills add langchain-ai/skills-benchmarks --skill api-docs -a claude-code`. Or copy the skill folder (skills/noise/api_docs in langchain-ai/skills-benchmarks) into .claude/skills/api-docs in your project. Claude Code loads it when a task matches its description.

How do I install API Docs in Codex?

Run `npx skills add langchain-ai/skills-benchmarks --skill api-docs -a codex`. Or copy the skill folder (skills/noise/api_docs in langchain-ai/skills-benchmarks) into .agents/skills/api-docs in your project. Codex loads it when a task matches its description.

Can I use API Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add langchain-ai/skills-benchmarks --skill api-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-docs, .gemini/skills/api-docs, .github/skills/api-docs and .opencode/skills/api-docs in your project.

What does API Docs need to run?

SKILL.md names no scripts, command-line tools or credentials: API Docs is instructions for the agent only.

Does API Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is API Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Docs use?

API Docs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Docs use?

About 358 tokens (SKILL.md is roughly 1.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Docs?

Skills that share tags, products or a category with API Docs: OpenAPI Spec Generation (wshobson/agents, 40k stars), API Documentation Writer (OneWave-AI/claude-skills, 323 stars), API Documenter (alirezarezvani/claude-code-tresor, 777 stars) and API Contract Design (rsmdt/the-startup, 551 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Docs?

langchain-ai (a GitHub organization, an official publisher) maintains it in langchain-ai/skills-benchmarks, which has 118 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on September 21, 2026.

Source: langchain-ai/skills-benchmarks on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

API Docs

Install API Docs

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

API Documentation Standards

OpenAPI Specification

REST Conventions

Error Responses

Files

Compare with similar skills

Similar skills

OpenAPI Spec Generation

API Documentation Writer

API Documenter

API Contract Design

Python Fastapi Patterns

Document API Endpoint

More from langchain-ai/skills-benchmarks

Framework Selection

Langchain Agents

Langchain Oss Primer

React Components

Testing Patterns

Database Migrations

Questions about API Docs

Install API Docs

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

API Documentation Standards

OpenAPI Specification

REST Conventions

Error Responses

Files

Compare with similar skills

Similar skills

More from langchain-ai/skills-benchmarks

Related

Questions about API Docs