design-an-interface

design-an-interface is a skill for Claude Code, Codex from BlueprintOS/analysis-to-delivery. It costs 39 tokens per session (750 once invoked), scanned A, original, MIT.

A bridge guide for designing an interface contract: a precise agreement about inputs, outputs, errors, and conditions between two parts of a system.

In plain words
What is it for?
Defining API or service contracts, documenting error codes and preconditions, and preparing work for domain modeling or implementation plans.
Why use it?
It helps callers and implementers agree on behavior before coding and makes the interface testable.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Defining API or service contracts, documenting error codes and preconditions, and preparing work for domain modeling or implementation plans.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/blueprintos/analysis-to-delivery/design-an-interface
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 BlueprintOS/analysis-to-delivery --skill design-an-interface
Clone the repo
git clone --depth 1 https://github.com/BlueprintOS/analysis-to-delivery

Made for: Claude Code, Codex.

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 design-an-interface

README.md
[![agentmods](https://agentmods.dev/badge/skills/blueprintos/analysis-to-delivery/design-an-interface/github.svg)](https://agentmods.dev/skills/blueprintos/analysis-to-delivery/design-an-interface)
Your own site
<a href="https://agentmods.dev/skills/blueprintos/analysis-to-delivery/design-an-interface"><img src="https://agentmods.dev/badge/skills/blueprintos/analysis-to-delivery/design-an-interface/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 design-an-interface

Your own site · 80×15
<a href="https://agentmods.dev/skills/blueprintos/analysis-to-delivery/design-an-interface"><img src="https://agentmods.dev/badge/skills/blueprintos/analysis-to-delivery/design-an-interface.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 39 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 750 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.00039 $0.00750
Opus 5 $0.00019 $0.00375
Sonnet 5 $0.00008 $0.00150
Haiku 4.5 $0.00004 $0.00075

Measured 9d ago against content hash c710636489ad, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

design-an-interface 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 9d 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.

skills/orchestration/development/design-an-interface/SKILL.md · 76 lines

What it actually says

Design-an-Interface(桥接到 superpowers)

Contract

  • Inputs: design spec, domain constraints, integration points
  • Outputs: interface contract document
  • Gates: interface is testable and accepted by caller/implementer
  • Required disciplines: stage-gate
  • Next: /domain-modeling or /writing-plans

本仓库不维护此 skill 的内容。完整纪律请读: <SUPERPOWERS_SKILL_ROOT>/design-an-interface/SKILL.md

何时调

  • brainstorming 之后,writing-plans 之前
  • 需要把功能拆成可测试的接口

衔接点

  • 产出:接口契约文档
  • 下一步:/domain-modeling/writing-plans
  • 门控:disciplines/stage-gate 第 2 层

降级方案(superpowers 未装时)

如果 <SUPERPOWERS_SKILL_ROOT>/design-an-interface/ 不存在,按以下 4 步产出接口契约:

1. 列举调用方与实现方

  • 调用方是谁?(controller / 巴枪 / 第三方系统)
  • 实现方是谁?(哪个 service / 模块)
  • 触发场景有哪些?(主动调用 / 事件回调 / 定时)

2. 写接口契约表

每个接口必须含 5 列:

含义 例子
Name 方法/路径名 POST /api/v1/asn/receive
Input 入参 schema {tcAsnId, lpnList[]}
Output 出参 schema {receivedQty, exceptionList[]}
Errors 错误码字典 E_ASN_NOT_FOUND(40401)
Pre/Post 前置/后置条件 前置:ASN 状态=10;后置:状态=30

3. 验收契约

  • 可测试性:每个契约都对应 1 个测试用例(契约层用)
  • 错误码对齐:与全局 09-QA审计报告 的错误码字典一致
  • 联调:与调用方对齐字段名 / 类型,字段名严禁猜测(走 disciplines/no-field-guessing)

4. 输出 + 签字

写到 docs/superpowers/specs/<topic>-interface.md,末尾 ## Sign-off 等用户白名单签字(4 句之一)。

最小纪律摘要

  • 契约是合同:写下来就不准改,改了要重新签字
  • 错误码全局唯一:不复用业务字段名当错误码
  • Pre/Post 必须:只写 Input/Output = 验收没边界
  • 联调不靠人脑:调用方拿到契约文档就能写 Mock

安装提示

npx skills@latest add obra/superpowers-design-an-interface
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. 9d ago First seen · 76 lines · 39 tokens per session scan A c710636489ad

Subscribe to this mod's changes

design-an-interface is a skill published in the GitHub repository BlueprintOS/analysis-to-delivery (26 stars, last pushed 2mo ago), licensed MIT. It adds 39 tokens to every session and 750 once invoked, about $0.0002 per session on Opus 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-08-30.

Related

Other skills, from other repositories

form-strategy

Design forms that convert, validate well, resist spam, and integrate cleanly with downstream systems. Use this skill when designing or auditing any form (contact, signup, checkout, multi-step, embedded), planning validation logic, fighting spam, choosing form tooling, or improving form conversion. Triggers on form…

rampstackco/claude-skills · 107 tokens

tanstack-start

Build a full-stack TanStack Start app on Cloudflare Workers from scratch — SSR, file-based routing, server functions, D1+Drizzle, better-auth, Tailwind v4+shadcn/ui. Use whenever the user mentions TanStack Start, asks to scaffold a full-stack Cloudflare app with SSR, wants an SSR dashboard, or asks for a React 19 +…

jezweb/claude-skills · 115 tokens

mcp-builder

Build MCP servers in Python with FastMCP. Define tools / resources / prompts, build the server, test locally, deploy to FastMCP Cloud or Docker. Use whenever the user mentions building an MCP server, exposing tools to LLMs, FastMCP, building a Claude integration, or troubleshooting FastMCP module-level server…

jezweb/claude-skills · 84 tokens

hono-api-scaffolder

Scaffold Hono API routes for Cloudflare Workers. Produces route files, middleware, typed bindings, Zod validation, error handling, and APIENDPOINTS.md documentation. Use after a project is set up with cloudflare-worker-builder or vite-flare-starter, when you need to add API routes, create endpoints, or generate API…

jezweb/claude-skills · 77 tokens

api-endpoint-scaffolder

Generate REST API endpoints with proper structure, validation, error handling, and types. Use when creating new API routes, endpoints, or backend services.

OneWave-AI/claude-skills · 36 tokens

cloudflare-worker-builder

Scaffold and deploy Cloudflare Workers with Hono routing, Vite plugin, and Static Assets. Describe project, scaffold structure, configure bindings, deploy. Use whenever the user wants to create a Worker project, set up Hono on Cloudflare, configure D1 / R2 / KV / Queues bindings, or troubleshoot Worker export syntax…

jezweb/claude-skills · 86 tokens