api-design

api-design is a skill for Claude Code from oborchers/fractional-cto. It costs 101 tokens per session (2,462 once invoked), scanned A, original, MIT.

A guide to designing the public interface of a Python library—the functions, classes, names, and errors that other programs are allowed to use. It covers exports, private implementation modules, exceptions, synchronous and asynchronous interfaces, and plug-ins.

In plain words
What is it for?
Use it when designing library APIs, choosing exported names, organising modules, defining errors, or adding plug-in support.
Why use it?
A public interface becomes a promise to users, so poorly chosen names or exports can make future changes break existing programs. The guide helps define that boundary deliberately.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the python-package plugin — 13 skills, 2 commands, 1 agent shipped together

Good fit Use it when designing library APIs, choosing exported names, organising modules, defining errors, or adding plug-in support.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/oborchers/fractional-cto/api-design
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add oborchers/fractional-cto --skill api-design
Clone the repo
git clone --depth 1 https://github.com/oborchers/fractional-cto

Made for: Claude Code.

Or install python-package, the plugin that ships this one along with the rest of its 13 skills, 2 commands, 1 agent.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for api-design

README.md
[![agentmods](https://agentmods.dev/badge/skills/oborchers/fractional-cto/api-design/github.svg)](https://agentmods.dev/skills/oborchers/fractional-cto/api-design)
Your own site
<a href="https://agentmods.dev/skills/oborchers/fractional-cto/api-design"><img src="https://agentmods.dev/badge/skills/oborchers/fractional-cto/api-design/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for api-design

Your own site · 80×15
<a href="https://agentmods.dev/skills/oborchers/fractional-cto/api-design"><img src="https://agentmods.dev/badge/skills/oborchers/fractional-cto/api-design.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 101 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,462 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00101 $0.02462
Opus 5.5 $0.00040 $0.00985
Sonnet 5.5 $0.00020 $0.00492
Haiku 4.5 $0.00010 $0.00246

Measured 3d ago against content hash 7db606554d9b, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

api-design scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

python-package/skills/api-design/SKILL.md · 202 lines

How it starts

The opening of the file, as written. The whole thing — 202 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Define Your Public API Surface and Defend It

The public API is the contract between your library and every downstream user. Once a symbol is public, removing or changing it is a breaking change. Getting the boundary right -- what is exported, what is private, how errors are communicated, how complexity is layered -- is the most consequential design decision in a Python library. Get it wrong and you end up like Pydantic v1: an unintentionally wide API surface that required a full rewrite to fix.

httpx is the gold standard. Every public symbol is re-exported from __init__.py. Every implementation module is underscore-prefixed (_client.py, _config.py). The exception hierarchy is a carefully designed tree. Sync and async clients share all non-I/O logic in a _BaseClient. Study httpx before designing your own API.

Public API Surface: __all__ and Underscore Modules

Every module that exports symbols must define __all__. This documents intent, controls from module import *, and tells tools (mypy, pyright, mkdocstrings) what is public.

Rule Rationale
Define __all__ in every public module Documents the contract; tools rely on it
Re-export everything from __init__.py Users write from mylib import Client, never from mylib._client import Client
Prefix all implementation modules with _ _client.py, _config.py, _exceptions.py make the private boundary unambiguous
Sort __all__ alphabetically Easy to review in diffs, easy to check for completeness
Include type aliases and protocols in __all__ Users need them for type-checking; easy to forget
Bad Good
from mylib.client import Client from mylib import Client
No __all__, everything implicitly public Explicit __all__ listing every public name
utils.py with mixed public/private helpers _utils.py for internal, re-export public helpers from __init__.py

Expose less than you think you need. You can always make something public later; you cannot easily make it private. If it is in __all__, it is a contract. If it starts with an underscore, you can change it freely.

Read the full file on GitHub · 202 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 202 lines · 101 tokens per session scan A 7db606554d9b

Subscribe to this mod's changes

api-design is a skill published in the GitHub repository oborchers/fractional-cto (32 stars, last pushed 3d ago), licensed MIT. It adds 101 tokens to every session and 2,462 once invoked, about $0.0004 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-10-13.

Related

Other skills, from other repositories

matlab

Builds, reviews, migrates, and plans MATLAB or GNU Octave numerical workflows. Use for arrays, tabular/time data, tests, projects, graphics, MAT files, and explicit Python interoperability.

K-Dense-AI/scientific-agent-skills · 44 tokens

pennylane

Builds and differentiates PennyLane quantum circuits, hybrid PyTorch or JAX models, molecular VQE and QAOA workflows. Use for variational quantum algorithms, quantum machine learning, simulator validation, and moving validated circuits to provider plugins. For hardware-specific compilation use qiskit or cirq; for…

K-Dense-AI/scientific-agent-skills · 74 tokens

rocm-kernels

Provides guidance for writing and benchmarking optimized Triton kernels for AMD GPUs (MI355X, R9700) on ROCm, targeting HuggingFace diffusers (LTX-Video, SD3, FLUX) and transformers. Core kernels: RMSNorm, RoPE 3D, GEGLU, AdaLN. Includes XCD swizzle, autotune, diffusers integration patterns, and LTX-Video pipeline…

huggingface/kernels · 93 tokens

holoscan-install-wheel

Install Holoscan SDK Python wheel via pip into a venv. Use for Python installs; not for native C++/apt or Conda installs.

NVIDIA/skills · 37 tokens

typing-exclusion-worker

Python typing exclusion worker: remove assigned mypy exclusion modules in small scoped batches, fix typing issues, run validation, and produce a structured completion summary. Use when running parallel typing-debt workers or when asked to remove modules from pyproject mypy exclusion overrides.

getsentry/skills · 57 tokens

python

Python development with ruff, mypy, pytest - TDD and type safety.

alinaqi/maggy · 18 tokens