packmind packmind-rest-api-endpoint-design.instructions.md

A set of conventions for designing REST APIs, which are web interfaces that let software exchange data through predictable URLs and requests.

In plain words
What is it for?
Use it when creating or reviewing API routes, especially actions such as accepting or rejecting a resource and deciding which identifiers belong in a URL.
Why use it?
It helps API endpoints clearly represent business actions and avoids ambiguous routes that are difficult to document or use.

Instructions file for GitHub Copilot

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.

agentmods
npx agentmods add instructions/packmindhub/packmind/packmind-rest-api-endpoint-design
Clone the repo
git clone --depth 1 https://github.com/PackmindHub/packmind

Made for: GitHub Copilot.

Per session 157 This file is loaded in full into every session.
When invoked 157 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.00157 $0.00157
Opus 5 $0.00078 $0.00078
Sonnet 5 $0.00031 $0.00031
Haiku 4.5 $0.00016 $0.00016

Measured 3d ago against content hash ea5a957bcce0, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

packmind packmind-rest-api-endpoint-design.instructions.md 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.

apps/api/.github/instructions/packmind-rest-api-endpoint-design.instructions.md · 11 lines

What it actually says

Standard: REST API Endpoint Design

Conventions for designing REST API endpoints that are predictable, self-documenting, and aligned with distinct business actions. Favors dedicated action endpoints over generic status updates, and rout... :

  • Create one endpoint per business action rather than a single endpoint handling multiple actions via request body
  • Only include resource IDs from the ownership chain in the route — omit IDs of related but non-parent resources
  • Use dedicated POST action endpoints (e.g., /reject, /accept) instead of a generic PATCH with a status field in the body

Full standard is available here for further request: REST API Endpoint Design

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 · 11 lines · 157 tokens per session scan A ea5a957bcce0

Subscribe to this mod's changes

packmind packmind-rest-api-endpoint-design.instructions.md is an instructions file published in the GitHub repository PackmindHub/packmind (306 stars, last pushed 5d ago), licensed Apache-2.0. It adds 157 tokens to every session, about $0.0008 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.