Skip to main content

Convert FastAPI apps into Agent Skills (CLI + SKILL.md)

Project description

fastapi-to-skill

PyPI version GitHub stars Author

Convert any FastAPI app into a CLI + SKILL.md for AI agents — in one command.

From API Chaos to Agent Skills

pip install fastapi-to-skill
fastapi-to-skill generate main:app

One Command. Agent-Ready.


The Problem

A year ago, APIs served frontends. Developers read docs, learned the UI, wrote integration code.

Now APIs serve AI agents. And agents don't read docs — they read skill files.

If your product has no SKILL.md, agents can't discover it, can't use it, and will use a competitor that does have one.

The new distribution channel is not the App Store. It's the agent skill registry.


The Solution

fastapi-to-skill takes your existing FastAPI app and generates everything an AI agent needs to use your API:

Output What it is
cli.py Standalone Typer CLI — one command per endpoint, no deps on this tool
SKILL.md Agent Skills file — works in Claude Code and any Agent Skills-compatible platform
install.sh One-line installer: serve the skill dir from your host, install anywhere with curl | sh

No MCP server. No AI costs. No infrastructure. Just files.


Why FastAPI?

FastAPI auto-generates an OpenAPI spec from your Python type hints. You write:

@app.post("/tasks")
def create_task(task: Task) -> TaskOut:
    ...

FastAPI gives you a full API contract for free — endpoints, parameters, request bodies, types, auth schemes. Always in sync with your code. No manual YAML.

fastapi-to-skill reads that spec with one call to app.openapi() and turns it into agent-ready tools. The whole pipeline is: your type hints → OpenAPI spec → CLI + SKILL.md.

Big thanks to @sebastianramirez for building FastAPI + Typer — an ecosystem where this kind of tooling is possible in a weekend.


Quick Start

Install

pip install fastapi-to-skill
# or for global CLI tools (recommended)
pipx install fastapi-to-skill

Generate from a FastAPI app

# main.py
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI(title="Task Manager API")

class Task(BaseModel):
    title: str
    done: bool = False

@app.post("/tasks")
def create_task(task: Task):
    ...

@app.get("/tasks/{task_id}")
def get_task(task_id: int):
    ...
fastapi-to-skill generate main:app

Output (folder name is derived from your API title):

skills/task-manager-api/
├── cli.py      ← standalone CLI
├── SKILL.md    ← agent skill file
└── install.sh  ← one-line installer served from your host

Use the generated CLI

cd skills/task-manager-api/
pip install typer httpx rich

# Run without a command — shows SKILL.md (AI-friendly)
python cli.py

# List all commands
python cli.py --help

# See body schema for any command
python cli.py create-task --help
# Body fields:
#   title: string (required)
#   done: boolean  default: False

# Call the API
python cli.py create-task --body '{"title": "Ship the feature"}'
python cli.py get-task 1
python cli.py list-tasks --done false

# Search commands by keyword
python cli.py search "task"

One-line install from your host

Serve the generated skill directory from your API, and anyone (or any agent) can install the skill with a single command:

# main.py
from fastapi.staticfiles import StaticFiles

app.mount("/skill", StaticFiles(directory="skills/task-manager-api"))
curl -fsSL https://api.myapp.com/skill/install.sh | sh

The script downloads cli.py and SKILL.md from your host into ~/.claude/skills/task-manager-api/ — where Claude Code discovers the skill automatically — and installs the Python dependencies if needed.

By default install.sh points to <base-url>/skill. Host the files somewhere else (a CDN, GitHub raw, S3) with:

fastapi-to-skill generate main:app --skill-url https://cdn.myapp.com/skill

Other options

# Preview without writing files
fastapi-to-skill generate main:app --dry-run

# Validate spec only
fastapi-to-skill generate main:app --validate

# Override base URL
fastapi-to-skill generate main:app --base-url https://api.myapp.com

Authentication

Set your credentials via environment variables before calling any command:

# API key
export MYAPI_API_KEY="sk-your-key"

# Bearer token
export MYAPI_TOKEN="your-token"

# Custom base URL
export MYAPI_BASE_URL="https://api.myapp.com"

The env var prefix is derived from your API title automatically.


How the SKILL.md works

When an AI agent encounters your CLI, it runs:

task-manager-api          # reads SKILL.md, understands the API
task-manager-api --help   # sees all available commands
task-manager-api create-task --help  # sees body schema

No human needed. The agent discovers capabilities, reads the contract, and starts calling commands.

The SKILL.md follows the Agent Skills open standard — compatible with Claude Code and any platform that supports it.


License

MIT


Built on FastAPI + Typer by Sebastian Ramirez.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastapi_to_skill-0.1.8.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastapi_to_skill-0.1.8-py3-none-any.whl (19.0 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_to_skill-0.1.8.tar.gz.

File metadata

  • Download URL: fastapi_to_skill-0.1.8.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for fastapi_to_skill-0.1.8.tar.gz
Algorithm Hash digest
SHA256 68ff9465881d2534cdbfdedf14a1d8d99829f948c3f5332ec6747995c64afbcc
MD5 c9cf38415ff0b614c8b740d27543c948
BLAKE2b-256 4b8c214f4c81a29049d52279c538966ff408181565adc86084195adf71a37711

See more details on using hashes here.

File details

Details for the file fastapi_to_skill-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_to_skill-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4801f3c2894672cf9355aeced70165224a475c5f8244e0b64f2a579909b3c87a
MD5 715394891903a7bdf7192e5660b904c6
BLAKE2b-256 aca22a3fc0f59087df466de54b6fbbdf55ec9ac0e229182b7e7f754ea8ac677d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page