nestjs-starter interfaces.instructions.md

Coding rules for TypeScript interfaces in a NestJS starter project. Interfaces describe the shape of data used by requests, responses, and database entities.

In plain words
What is it for?
Use them when defining database entity types, create and update inputs, authenticated-user data, and API response shapes.
Why use it?
They keep data definitions consistent and prevent duplicated or overly loose types such as any.

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/hmake98/nestjs-starter/interfaces
Clone the repo
git clone --depth 1 https://github.com/hmake98/nestjs-starter

Made for: GitHub Copilot.

Per session 287 This file is loaded in full into every session.
When invoked 287 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.00287 $0.00287
Opus 5 $0.00143 $0.00143
Sonnet 5 $0.00057 $0.00057
Haiku 4.5 $0.00029 $0.00029

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

Security

Grade A, and why

nestjs-starter interfaces.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 2d 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.

.github/instructions/interfaces.instructions.md · 49 lines

What it actually says

Interface Conventions

Database entity interfaces (src/common/database/interfaces/)

import type { Post } from '@prisma/client';

// Entity is always a direct type alias from Prisma — never re-declared
export type PostEntity = Post;

// CreateInput: all fields required for creation (no id, createdAt, updatedAt, deletedAt)
export interface CreatePostInput {
    title: string;
    authorId: string;
    published?: boolean;
}

// UpdateInput: all fields optional
export interface UpdatePostInput {
    title?: string;
    published?: boolean;
}

Request interfaces (src/common/request/interfaces/)

// IAuthUser: what JwtAccessGuard puts on request.user
export interface IAuthUser {
    userId: string;
    role: UserRole;
}

Response interfaces (src/common/response/interfaces/)

  • Mirror the DTO shape for use in interceptors/filters.
  • Use generics for data payloads (IApiSuccessResponse<T>).

Rules

  • Never use any — use unknown with type narrowing or a proper interface.
  • No business logic in interface files — types and interfaces only.
  • Import Prisma types with import type { X } from '@prisma/client' — always type import.
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. 2d ago First seen · 49 lines · 287 tokens per session scan A fc03b7d61466

Subscribe to this mod's changes

nestjs-starter interfaces.instructions.md is an instructions file published in the GitHub repository hmake98/nestjs-starter (61 stars, last pushed 3mo ago), licensed MIT. It adds 287 tokens to every session, about $0.0014 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 instructions, from other repositories