Set Up Agent Instructions for Orbital API

Problem/Feature Description

The Orbital team has been struggling with repeated mistakes whenever a new developer or AI agent onboards to their Node.js API codebase. Tests keep passing locally but failing in CI, a critical environment variable keeps getting missed during setup, and agents keep accidentally modifying a module that's in the middle of a sensitive migration. The team lead wants a single authoritative file placed at the repository root that will guide agents working in this codebase — capturing everything that isn't obvious from reading the code itself.

The repository doesn't have any agent instruction file yet. Your job is to audit the codebase files provided, identify what agents genuinely cannot discover on their own, and produce a complete, well-filtered set of agent instructions.

Output Specification

Produce the following files in your working directory:

• AGENTS.md — the agent instructions file at the root level
• audit-notes.md — a log of every item you considered but excluded, with a one-line reason for each exclusion citing which file makes it discoverable

Input Files

The following files are provided as inputs. Extract them before beginning.

=============== FILE: README.md ===============

Orbital API

A REST API service for the Orbital platform.

Setup

Install dependencies with yarn:

yarn install

Run the development server:

npm run dev

Run tests:

npm test

Project Structure

The src/ directory contains all source code. Entry point is src/index.ts.

Contributing

Follow standard TypeScript best practices. Write tests for new features. Keep functions focused and well-named.

=============== FILE: package.json =============== { "name": "orbital-api", "version": "2.4.1", "scripts": { "dev": "ts-node src/index.ts", "build": "tsc", "test": "jest", "lint": "eslint src --ext .ts" }, "dependencies": { "express": "^4.18.2", "ioredis": "^5.3.2", "pg": "^8.11.0" }, "devDependencies": { "@types/express": "^4.17.21", "@types/jest": "^29.5.8", "eslint": "^8.54.0", "jest": "^29.7.0", "ts-jest": "^29.1.1", "typescript": "^5.3.2" } }

=============== FILE: package-lock.json =============== { "name": "orbital-api", "version": "2.4.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "orbital-api", "version": "2.4.1" } } }

=============== FILE: .env.example =============== DATABASE_URL=postgres://localhost:5432/orbital_dev NODE_ENV=development PORT=3000

=============== FILE: .eslintrc.json =============== { "parser": "@typescript-eslint/parser", "rules": { "no-console": "warn", "no-unused-vars": "error", "prefer-const": "error" } }

=============== FILE: .github/workflows/ci.yml =============== name: CI

on: [push, pull_request]

jobs: test: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: node-version: '20' - run: npm ci - run: npm test -- --no-cache --forceExit - run: npm run lint

=============== FILE: src/index.ts =============== import express from 'express'; import { createClient } from 'ioredis'; import { legacyPaymentsRouter } from './legacy-payments';

const app = express(); const PORT = process.env.PORT || 3000;

const redis = createClient({ url: process.env.REDIS_URL, });

const dbUrl = process.env.DATABASE_URL; const secretKey = process.env.APP_SECRET_KEY;

app.use('/api/payments/legacy', legacyPaymentsRouter);

app.listen(PORT, () => { console.log(Server running on port ${PORT}); });

=============== FILE: src/legacy-payments/index.ts =============== // Legacy payments module - DO NOT MODIFY // This module is being migrated to the new payments-v2 service. // All new payment logic should go in src/payments-v2/ // Contact: platform-team@orbital.io before making any changes here. export { legacyPaymentsRouter } from './router';

=============== FILE: src/payments-v2/index.ts =============== // New payments module - all new payment features go here import express from 'express'; export const paymentsV2Router = express.Router();