← Explore all skills

API FRAMEWORKS / FastAPI

FastAPI conventions

Official FastAPI skill for Annotated dependencies, return types, router-level configuration, and SSE through EventSourceResponse.

“FastAPI best practices and conventions. Use when working with FastAPI APIs, Pydantic models, dependencies, streaming responses including Server-Sent Events (SSE), and serving frontend apps. Keeps FastAPI code clean and up to date with the latest features and patterns.”

01 / THE REASONING

Why this made the selection.

  • The primary file specifies Annotated dependencies, a return type ahead of response_model, router-level prefix and dependencies, and EventSourceResponse for server-sent events.
  • The same file tells the reader not to use ORJSONResponse, UJSONResponse, or Pydantic RootModel, and to declare the CLI entrypoint in pyproject.toml.

02 / THE REVIEW RECORD

What we actually inspected.

Source review has boundaries.
A clear record is more useful than a “safe” badge.

Material inspected

  • fastapi/.agents/skills/fastapi/SKILL.md
  • LICENSE at the same commit
  • fastapi/.agents/skills/fastapi/SKILL.md compared with the previous review revision 94918c1d: one paragraph changed, in the OpenTelemetry section; LICENSE unchanged.

Our findings

  • LICENSE opens with The MIT License (MIT) and Copyright (c) 2018 Sebastián Ramírez.
  • The procedure, including the CLI commands and the response refusals, is in the primary file.
  • Its OpenTelemetry section prefers FastAPI's native support: fastapi[standard] for the exporters, FASTAPI_OTEL_AUTO_CONFIGURE=true for automatic setup, and OTEL_SERVICE_NAME, OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS for the collector.

Not established by this review

  • fastapi dev and fastapi run were not executed.
  • The linked reference markdown and the FastAPI Python modules named by the skill were not line-reviewed.
  • Not executed: it was not installed or run.

The review applies to the material and revision named here. A newer upstream release can change its behavior.

03 / PUT IT TO WORK

Add a skill to your workflow.

Upstream setup instructions ↗

DOCUMENTED COMMAND

npx skills add fastapi/fastapi/fastapi/.agents/skills/fastapi

Run in your terminal to choose your AI tools, project or global scope, and installation method. This short command follows the current upstream version; the review covers the revision shown above.

Optional: install the reviewed revision

Keeps the original source and installer version where recorded, while leaving your AI tools and installation scope for you to choose.

npx skills add https://github.com/fastapi/fastapi/tree/f5c6e9b4f9cadc1bf0f9a1fd672e621206b63007/fastapi/.agents/skills/fastapi
  1. The command pins this skill directory at the reviewed commit. The installer was not executed.
  2. A shorter command that adds the whole fastapi/fastapi tree can pull other skills this review did not open.

Before you start

  • Node.js and npm
  • A Python environment when you later run the FastAPI CLI

04 / FOLLOW THE EVIDENCE

The source trail.

Our notes are separate from the original resource.
Check upstream before adopting a new version.

  1. Skill definition ↗Checked

    https://github.com/fastapi/fastapi/blob/f5c6e9b4f9cadc1bf0f9a1fd672e621206b63007/fastapi/.agents/skills/fastapi/SKILL.md

    Supports: summary, whySelected, limitations

  2. MIT licence ↗Checked

    https://github.com/fastapi/fastapi/blob/f5c6e9b4f9cadc1bf0f9a1fd672e621206b63007/LICENSE

    Supports: Redistribution terms and copyright notice

  3. https://github.com/vercel-labs/skills/blob/13e4063a1cf913f5606d57d42ab83a86f5001e04/README.md

    Supports: install

  4. https://github.com/vercel-labs/skills/blob/13e4063a1cf913f5606d57d42ab83a86f5001e04/src/git.ts

    Supports: install

  5. https://raw.githubusercontent.com/fastapi/fastapi/f5c6e9b4f9cadc1bf0f9a1fd672e621206b63007/fastapi/.agents/skills/fastapi/SKILL.md

    Supports: upstreamDescription, review.notTested, review.reviewedAt, bestFor

Evidence & Ask