mcpbeat

API Docs

langchain-ai/api-docs

OpenAPI documentation and REST API design patterns

357 tokens
context cost
the whole folder, loaded on every use
1
files
instructions only
0
copies elsewhere
how many repositories repackaged it
111
stars on the repo
on the repository, not the skill itself

Install

one command, takes just this skill from the repository 
npx skills add https://github.com/langchain-ai/skills-benchmarks --skill api-docs

The instruction itself

4 sections, as written by the author

API Documentation Standards

Design and document RESTful APIs following industry standards.

OpenAPI Specification

Always document APIs using OpenAPI 3.0+:

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

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

How to use it

Copy the folder

Take langchain-ai/api-docs from the repository into ~/.claude/skills for personal use, or into .claude/skills inside a project.

Check the name does not clash

The agent identifies a skill by the name field in its header. Two skills with the same name cannot sit side by side — one of them will be ignored.