GO SERVICE AGENTS.MD

An HTTP service in Go using the standard library router. Go has strong conventions and fast tooling; these rules make sure an agent follows them instead of importing frameworks and patterns from other languages.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
The Go service filesCustomize in the generator
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: go-service. An HTTP service in Go using net/http and PostgreSQL.

This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.

## Stack

- Language: Go
- Framework: Go standard library (net/http)
- Database: PostgreSQL
- Hosting: Google Cloud
- Tests: go test
- Package manager: Go modules

## Commands

Run these from the repository root.

- Install dependencies: `go mod download`
- Run locally: `go run ./cmd/server`
- Build: `go build ./...`
- Run all tests: `go test ./...`
- Run one test file: `go test ./internal/orders -run TestCreateOrder`
- Lint: `go vet ./...`
- Format: `gofmt -w .`

## Project layout

- `cmd/server/`: main package: wiring and startup
- `internal/`: Application packages, not importable by other modules
- `internal/http/`: Handlers and routing (http.ServeMux)
- `internal/store/`: Database access
- `migrations/`: SQL migrations

## Code style

- Indent with tabs. Never spaces for indentation.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Prefer small pure functions and immutable data; keep side effects at the edges (handlers, jobs, I/O modules).
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Comments explain why the code is the way it is. Do not add comments that restate what the code does.
- Commit messages follow Conventional Commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, with an imperative summary under 72 characters.

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.

## Product constraints

- Changes must be backward compatible across a rolling deploy: old and new code run side by side, so migrations and API changes go in safe steps.

## Project-specific notes

- Code must be `gofmt`-formatted and pass `go vet ./...`.
- Return errors, do not panic. Wrap with context using `fmt.Errorf("doing x: %w", err)` and check with `errors.Is` or `errors.As`.
- Pass `context.Context` as the first parameter to anything that does I/O, and respect cancellation.
- Use the standard library `http.ServeMux` with method and path patterns (`mux.HandleFunc("GET /items/{id}", ...)`); do not add a router dependency.
- Write table-driven tests with `t.Run` subtests; use `httptest` for handlers.
- Run tests with `-race` before saying concurrent code is done: `go test -race ./...`.
- Accept interfaces where you need them, return concrete types; do not create interfaces with a single implementation up front.

## Project phase

This project is in active development. Follow the patterns that already exist; consistency beats novelty.
CLAUDE.mdFor Claude Code
# CLAUDE.md

@AGENTS.md

## Claude Code

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
GEMINI.mdFor Gemini CLI
# GEMINI.md

@./AGENTS.md

## Gemini CLI

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
.github/copilot-instructions.mdFor GitHub Copilot
# Copilot instructions

Project: go-service. An HTTP service in Go using net/http and PostgreSQL.

The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.

## Stack

- Language: Go
- Framework: Go standard library (net/http)
- Database: PostgreSQL
- Hosting: Google Cloud
- Tests: go test
- Package manager: Go modules

## Commands

- Install dependencies: `go mod download`
- Run locally: `go run ./cmd/server`
- Build: `go build ./...`
- Run all tests: `go test ./...`
- Run one test file: `go test ./internal/orders -run TestCreateOrder`
- Lint: `go vet ./...`
- Format: `gofmt -w .`

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
.cursor/rules/project.mdcFor Cursor
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---

# Project rules

The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.

Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.

Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).

These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.

About the Go service preset

What Is in the Go service AGENTS.md?

The preset describes a an HTTP service in Go using net/http and PostgreSQL. Its AGENTS.md is 51 non-empty lines with 7 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: go mod download, go run ./cmd/server, go build ./..., go test ./..., go test ./internal/orders -run TestCreateOrder, go vet ./..., gofmt -w ..
  • Layout: cmd/server/, internal/, internal/http/, internal/store/, migrations/.
  • Wrappers: CLAUDE.md and GEMINI.md import AGENTS.md; the Copilot file repeats the essentials; the Cursor rule points to AGENTS.md.

Why These Rules for Go service?

Errors are values

Agents from exception-based languages panic or log-and-continue. Go expects wrapped errors returned up the stack with context at each level, which makes failures traceable without a debugger.

Context carries cancellation

Without a context, a slow database call keeps running after the client has gone. Threading context through is tedious, which is exactly why agents skip it.

The standard router is enough now

Go 1.22 added method and wildcard patterns to ServeMux. Older examples import third-party routers by reflex; the rule keeps the dependency list short.

Race detector

Data races pass ordinary tests and fail in production. The race flag is cheap to run and catches most of them.

Which Stack Rules Does the File Add?

  • Code must be gofmt-formatted and pass go vet ./....
  • Return errors, do not panic. Wrap with context using fmt.Errorf("doing x: %w", err) and check with errors.Is or errors.As.
  • Pass context.Context as the first parameter to anything that does I/O, and respect cancellation.
  • Use the standard library http.ServeMux with method and path patterns (mux.HandleFunc("GET /items/{id}", ...)); do not add a router dependency.
  • Write table-driven tests with t.Run subtests; use httptest for handlers.
  • Run tests with -race before saying concurrent code is done: go test -race ./....
  • Accept interfaces where you need them, return concrete types; do not create interfaces with a single implementation up front.

How Do You Add These Files to a Go service Repository?

  1. Download the zip above. It is laid out exactly as the files go into the repository.
  2. Unzip it at the repository root. AGENTS.md, CLAUDE.md and GEMINI.md go next to your README; the Copilot file goes in .github/ and the Cursor rule in .cursor/rules/.
  3. Open AGENTS.md and check every command against your package scripts or Makefile.
  4. Delete wrappers for tools your team does not use, and any old .cursorrules or .windsurfrules file.
  5. Commit, then run the linter on AGENTS.md whenever you change it.

Want different commands or rules? Load this preset into the generator, change anything, and download your own set.

Which Agents Will Read These Files?

AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.

Where Are the Other Stacks?

All presets are on the stacks page.

Frequently Asked Questions

Why is lint go vet and not golangci-lint?

go vet ships with Go and needs no setup. If your project runs golangci-lint, put that command in the generator instead.

Why tabs?

gofmt uses tabs for indentation and every Go project follows gofmt, so the indent rule matches the formatter.

Can I use this with Gin or Echo?

Choose Gin in the generator and remove the ServeMux rule. The error, context and testing rules stay the same.

Are these Go service files free to use?

Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.

How Can You Verify That Nothing Leaves This Browser?

You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.

  1. Open your browser developer tools with F12, or Cmd+Option+I on a Mac, and select the Network tab.
  2. Reload the page and let it finish. You will see the page's own files, its web fonts, and one anonymous page-view request. Nothing has been typed yet, so none of them can contain your input.
  3. Click the clear icon in the Network tab so that the log is empty.
  4. Switch between the file tabs, copy a file and download the zip.
  5. Look at the Network tab again. It is still empty. Downloads are built in the page as Blob URLs, so even the zip never touches a server. For extra proof, turn on offline mode after the page loads: everything keeps working.

Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.

Was this helpful?