菜单
Define backend API contract standards for FastAPI services. Use when adding or refactoring HTTP/WebSocket endpoints in app/api, designing request/response schemas in app/models/schema.py, standardizing status/error contracts, and maintaining backward compatibility for clients.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/AUTO-MAS-Project/skills --skill mas-api-contract命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
正在显示 SKILL.md
用于新增、修改或审查 AUTO-MAS 插件模块，包括插件管理/市场 UI、插件页面扩展、插件声明与实例、声明式 HTTP/WS、Script Adapter、动态 Schema 表单及插件运行链。
Master entrypoint for MAS engineering standards and code conventions. Use when a task needs consistent conventions across code standards, schema naming, module boundaries, function design, API contracts, or data modeling, and route the work to one or more MAS sub-skills.
Guide specialized AUTO-MAS integration by script frontend architecture (MAA / SRC / MXU-line like MaaEnd / MFAA-line like M9A / ok-script like Okww). Before coding: run script-architecture intake (prefer repo URL). Surfaces first, then backend. Code norms: references/adapter-code-norms.md.
基于 SOC 职业分类
| name | mas-api-contract |
| description | Define backend API contract standards for FastAPI services. Use when adding or refactoring HTTP/WebSocket endpoints in app/api, designing request/response schemas in app/models/schema.py, standardizing status/error contracts, and maintaining backward compatibility for clients. |
Keep backend API interfaces stable, consistent, and easy to consume.
Apply these constraints while using this skill.
Apply to:
app/api/*.app/models/schema.py.Current dev baseline:
OutBase-style envelopes used in app/models/schema.py.app/api/core.py and WS command routes./api/<resource>/start, /stop, /reorder).POST query-style endpoints such as combobox/list options, prefer one endpoint with an explicit request-body discriminator over splitting equivalent endpoints by implementation type./xxx-foo and /xxx-bar solely because the backend reads different config books; keep the path semantic stable and put the selected type in the body.*In for request models.*Out for response models.OutBase for common response envelope fields when applicable.response_model explicitly.app/models/schema.py before wiring a new route.app/api/ module and keep route handlers as thin transport adapters around schema models and backend calls.mas-schema-naming.scriptId, queueId, userId, etc.).code, status, message) for handled failures.id, type, data).Literal[...] field into Union[...] plus shared type aliases unless you have verified that the generated TypeScript runtime exports remain unchanged.http://127.0.0.1:36163/openapi.json with openapi --output ./src/api --client axios instead of hand-editing generated TypeScript.yarn dev can use the remote dev backend; start the local backend first when verifying local API changes.api layer owns transport contract mapping only.schema layer owns model definitions only.core/task/services own business execution and integration logic.mas-module-boundary for placement and dependency checks.*In/*Out models are present and explicit.response_model is declared.POST endpoints do not multiply paths when a body selector would keep the contract simpler.