API Design Consistency SKILL.md skillA
API Design Consistency from s977043/river-review is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add s977043/river-review/API Design Consistency@v0.1.0Pins v0.1.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- s977043/river-review
- Path
skills/upstream/api-design/SKILL.md- Versions recorded
- 3
- Latest version
- v0.1.0, committed Jul 19, 2026
- First version recorded
- Jun 29, 2026
- Size
- 2,903 bytes
- Repository stars
- 7
- License
- MIT
Ensure API design follows RESTful naming and consistent conventions.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
## Pattern declaration
Primary pattern: Reviewer
Secondary patterns: Inversion
Why: APIエンドポイントの命名・エラー応答・認可の一貫性をRESTful基準で検証する。
## Rule / ルール
- エンドポイントはリソース指向の RESTful 命名に従う（動詞を避ける）
- ステータスコードとエラーレスポンスを一貫させる
- バージョニングや認可要件を明示する
## Heuristics
- `/getUser`, `/doAction` のような動詞ベースのパス
- 4xx/5xx のステータスやエラー構造がエンドポイントごとに不揃い
- 認可・バージョンの記載が ADR/設計と乖離
## Good / Bad Examples
- Good: `/users/{id}`, `/projects/{id}/members`
- Bad: `/fetchUser`, `/doLoginNow`
- Good: エラーボディに code/message/detail を含めて統一
## Actions / 改善案
- パスをリソース指向にリネームし、コレクション/単体の区別を明確にする
- エラー応答を共通スキーマに合わせる
- ADR/設計で定義した認可・バージョン要件をエンドポイント仕様に反映する
## Non-goals / 扱わないこと
- API ゲートウェイやルーティング基盤の再設計。
- 既存クライアントの破壊的変更に関する移行計画。
- 実装レベルのパフォーマンス最適化。
## Pre-execution Gate / 実行前ゲート
このスキルは以下の条件がすべて満たされない限り`NO_REVIEW`を返す。
- [ ] 差分にAPI定義またはルーティング関連ファイル（`**/api/**`, `**/routes/**`）が含まれている
- [ ] 差分にエンドポイントの追加・変更・削除が含まれている
- [ ] inputContextに`diff`が含まれている
ゲート不成立時の出力: `NO_REVIEW: api-design — API定義/ルーティングの変更なし`
## False-positive guards / 抑制条件
- 既存の API ガイドラインに完全準拠している差分。
- 自動生成された API 定義の更新のみで、設計意図に変化がない。
## 評価指標（Evaluation）
- 合格基準: 指摘が差分に紐づき、根拠と次アクションが説明されている。
- 不合格基準: 差分と無関係な指摘、根拠のない断定、抑制条件の無視。
## 人間に返す条件（Human Handoff）
…Read the whole file at its exact version.
How to install
mdr add s977043/river-review/API Design Consistency@sha256:ca6e41409ac9ce83The line at the top of this page pins the label v0.1.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_ifn2uf5b77qtqm33)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Jun 29, 2026 and Jul 19, 2026, about one every 10 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v0.1.0 latest | 2026-07-19 | 6e21e08 | 2,903 B | A | view · diff |
| v0.1.0 | 2026-06-29 | 45e66bc | 2,908 B | A | view · diff |
| v0.1.0 | 2026-06-29 | b988700 | 2,924 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (2903 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
s977043/river-review · 7 stars · license MIT · pushed 2026-11-08 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ifn2uf5b77qtqm33 GET https://markdownregistry.com/api/v1/resolve?ref=s977043/river-review/API Design Consistency GET https://markdownregistry.com/api/v1/blob/ca6e41409ac9ce83220e14a4d139eb180993412e295d5bf0a2ea2e0b8c7efd1a
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from s977043/river-review
Every file in s977043/river-review