What is go-rest-api-boilerplate AGENTS.md?

Project instructions for GRAB, a Go starter project for building web APIs. They describe its tools, code structure, testing, database, Docker workflow, and authentication setup.

Use them when asking an agent to develop, test, configure, or understand the GRAB Go REST API project.

They give a coding agent the project context and working rules needed to make changes that fit the existing application.

How vahiiiid/go-rest-api-boilerplate configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to vahiiiid/go-rest-api-boilerplate. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/vahiiiid/go-rest-api-boilerplate/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/vahiiiid/go-rest-api-boilerplate

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/vahiiiid/go-rest-api-boilerplate/agents-md/github.svg)](https://agentmods.dev/instructions/vahiiiid/go-rest-api-boilerplate/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/vahiiiid/go-rest-api-boilerplate/agents-md"><img src="https://agentmods.dev/badge/instructions/vahiiiid/go-rest-api-boilerplate/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/vahiiiid/go-rest-api-boilerplate/agents-md"><img src="https://agentmods.dev/badge/instructions/vahiiiid/go-rest-api-boilerplate/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 4,878 This file is loaded in full into every session.

When invoked 4,878 The same file — it is already loaded in full.

Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.

Origin 88% copy Near-identical to another mod 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.

Model	Per session	Once invoked
Fable 5.1	$0.04878	$0.04878
Opus 5.5	$0.01951	$0.01951
Sonnet 5.5	$0.00976	$0.00976
Haiku 4.5	$0.00488	$0.00488

Measured 2mo ago against content hash 1f33a2cdcf4f, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

go-rest-api-boilerplate AGENTS.md scanned grade A with 1 finding 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 2mo 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

| Health check | `curl localhost:8080/health` |

Origin

This is a copy

88% identical to go-rest-api-boilerplate copilot-instructions.md — 889 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

AGENTS.md · 649 lines

How it starts

The opening of the file, as written. The whole thing — 649 lines — stays where its author put it; the contents beside it link to each section on GitHub.

GRAB - AI-Friendly Development Guide

Version: v2.0.0
Last Updated: 2025-12-10
Purpose: Universal AI assistant guidelines for GRAB (Go REST API Boilerplate)

This file follows the AGENTS.md standard (stewarded by the Agentic AI Foundation) and is compatible with all major AI coding assistants including GitHub Copilot, Cursor, Windsurf, Claude Code, JetBrains AI, and others.

This is the canonical source of truth for GRAB's AI guidelines. Claude Code reads it via CLAUDE.md's @AGENTS.md import; Copilot, Cursor, and Windsurf each keep a condensed, manually-synced adapter. See .agents/AI-CONFIG.md for the full file map and the rule for keeping them in sync.

📋 Project Overview

GRAB (Go REST API Boilerplate) is a production-ready Go REST API starter with Clean Architecture, comprehensive testing (89.81% coverage), and Docker-first development workflow.

Technology Stack

Go: Check version with go version
Gin: HTTP router framework
GORM: PostgreSQL ORM
PostgreSQL: Check version with make exec-db then psql --version
Docker: Check version with docker --version
golang-migrate: Database migration tool
JWT: Authentication with refresh token rotation
Air: Hot-reload development
golangci-lint: Code quality enforcement
Swagger: OpenAPI documentation

Documentation

Main Docs: https://vahiiiid.github.io/go-rest-api-docs/
Repository: https://github.com/vahiiiid/go-rest-api-boilerplate
Issues: https://github.com/vahiiiid/go-rest-api-boilerplate/issues

🏗️ Architecture

Clean Architecture Pattern

GRAB strictly follows Clean Architecture with clear layer separation:

Handler (HTTP) → Service (Business Logic) → Repository (Database)

Domain Structure:

internal/<domain>/
├── model.go       # GORM models with database tags
├── dto.go         # Data Transfer Objects (API contracts)
├── repository.go  # Database access interface + implementation
├── service.go     # Business logic interface + implementation
├── handler.go     # HTTP handlers with Gin + Swagger annotations
└── *_test.go      # Unit and integration tests

Read the full file on GitHub · 649 lines

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.

2mo ago First seen · 649 lines · 4,878 tokens per session scan A 1f33a2cdcf4f

Subscribe to this mod's changes

go-rest-api-boilerplate AGENTS.md is an instructions file published in the GitHub repository vahiiiid/go-rest-api-boilerplate (72 stars, last pushed 2mo ago), licensed MIT. It adds 4,878 tokens to every session, about $0.0195 per session on Opus 5.5. A static security scan graded it A with 1 finding (makes network calls). It is 88% identical to go-rest-api-boilerplate copilot-instructions.md, differing in 889 lines, and is treated as a copy.

Backend and APIs Go Languages api api-documentation authentication boilerplate clean-architecture

go-rest-api-boilerplate AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
go-rest-api-boilerplate AGENTS.mdvahiiiid/go-rest-api-boilerplate	Instructions file	72	2mo ago	MIT	A	4,878	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

go-rest-api-boilerplate: Instructions file for Codex