Home / rudycity / superagent · GitHub

api-design-principles SKILL.md skillA

This file is byte-identical to the first copy the registry indexed, one of 4 indexed copies. Same content hash, so the same checks give both the same grade.

api-design-principles from rudycity/superagent is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add rudycity/superagent/api-design-principles@git:20260626.019dba9

Pins git:20260626.019dba9 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: rudycity/superagent
Path: .agents/skills/api-design-principles/SKILL.md
Versions recorded: 1
Latest version: git:20260626.019dba9, committed Jun 26, 2026
Size: 3,603 bytes
Repository stars: 64
License: MIT

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.

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

# API Design Principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

## When to Use This Skill

- Designing new REST or GraphQL APIs
- Refactoring existing APIs for better usability
- Establishing API design standards for your team
- Reviewing API specifications before implementation
- Migrating between API paradigms (REST to GraphQL, etc.)
- Creating developer-friendly API documentation
- Optimizing APIs for specific use cases (mobile, third-party integrations)

## Core Concepts

### 1. RESTful Design Principles

**Resource-Oriented Architecture**

- Resources are nouns (users, orders, products), not verbs
- Use HTTP methods for actions (GET, POST, PUT, PATCH, DELETE)
- URLs represent resource hierarchies
- Consistent naming conventions

**HTTP Methods Semantics:**

- `GET`: Retrieve resources (idempotent, safe)
- `POST`: Create new resources
- `PUT`: Replace entire resource (idempotent)
- `PATCH`: Partial resource updates
- `DELETE`: Remove resources (idempotent)

### 2. GraphQL Design Principles

**Schema-First Development**

- Types define your domain model
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add rudycity/superagent/api-design-principles@sha256:1f6166c23c0a0f32

The line at the top of this page pins the label git:20260626.019dba9, 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.

Badge

[![mdr](https://markdownregistry.com/badge/art_jypccuajlz6zqg2x.svg)](https://markdownregistry.com/a/art_jypccuajlz6zqg2x)

6 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Jun 26, 2026.

version	committed	commit	size	audit
git:20260626.019dba9 latest	2026-06-26	019dba9	3,603 B	A	view

Audit of the latest version

A 17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.

pass: Frontmatter block present
pass: Frontmatter declares a name
pass: Frontmatter declares a description
pass: Size between 200 bytes and 200 KB (3603 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

GitHub

rudycity/superagent · 64 stars · license MIT · pushed 2026-11-06 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_jypccuajlz6zqg2x
GET https://markdownregistry.com/api/v1/resolve?ref=rudycity/superagent/api-design-principles
GET https://markdownregistry.com/api/v1/blob/1f6166c23c0a0f32d703c19d84b3c30c2873daefb9e8732339a009934fa17013

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 rudycity/superagent

AGENTS.md@.agents AGENTS.md file

rudycity/superagent · .agents/AGENTS.md

git:20261029.6635862 · audit B · 64 stars

accessibility-compliance SKILL.md skill

rudycity/superagent · .agents/skills/accessibility-compliance/SKILL.md · Implement WCAG 2.2 compliant interfaces with mobile accessibility, inclusive design patterns, and assistive technology…