Skip to content

Consult the standards

Set up AGENTS.md so coding agents read the engineering standards before they act on anything the standards cover.

Updated View as MarkdownView on Github

This site is the source of truth for NinjaTrader engineering standards. A coding agent that works from memory, a stale copy, or a skill’s bundled summary can give advice the site has since changed. Point every agent at the site and tell it which work needs a read first.

Add one section to the root AGENTS.md of each repository. Agent instructions allows extra headings after the required ones, so this section goes at the end. CLAUDE.md stays a single import of AGENTS.md, so every approved agent gets the same rule from one file.

Agent How it receives the section
Claude Code CLAUDE.md imports AGENTS.md.
Codex Reads AGENTS.md directly.
Cursor Reads AGENTS.md directly.
OpenCode Reads AGENTS.md directly.

Quick start

  1. Install cloudflared. The site sits behind Cloudflare Access and Okta, so an agent without a session gets a 302 redirect. See Access for agents.
  2. Run cloudflared access login https://engineering-standards.ninjatrader.dev once, from an interactive terminal. It opens a browser for Okta.

Then tell your agent:

Fetch https://engineering-standards.ninjatrader.dev/ai-consult-standards/index.md
and add its "AGENTS.md snippet" section to this repository's AGENTS.md, after the
required headings. Make CLAUDE.md contain only @AGENTS.md.

Every page on this site has a Markdown twin at /<slug>/index.md. This page’s twin is /ai-consult-standards/index.md, so the agent can read the snippet without parsing HTML. To copy the snippet yourself, use the next section.

AGENTS.md snippet

Add this section to the root AGENTS.md, after Stop conditions. Remove any bullet that does not apply to the repository.

## Engineering standards

Read https://engineering-standards.ninjatrader.dev/llms.txt before you make decisions governed by NinjaTrader's engineering standards. It is the source of truth.

- Use `llms.txt` as the index. Fetch the page that covers the task, then follow its links.
- Fetch https://engineering-standards.ninjatrader.dev/llms-full.txt when you need to read the whole corpus.
- Trust the site over any copy in a skill, a prompt, or your memory. Copies lag.
- If you are given a 302 Redirect when trying to access, run `cloudflared access login --quiet --auto-close https://engineering-standards.ninjatrader.dev` first.
- Read the matching standard before you start any of these:
  - creating or setting up a repository, service, or project, including scaffolding and project templates
  - choosing a language, framework, library, or tool
  - architecture, domain modeling, and API contracts
  - CI/CD, quality gates, testing, and cross-platform support
  - code review, four-eyes, and code ownership
  - releases and incidents
  - observability: errors, telemetry, logs, dashboards, and paging
  - feature flags
  - security, secrets, licensing, and authentication
  - internationalisation and the design system
  - design documents, RFCs, ADRs, and exceptions
  - documentation, README, runbooks, AGENTS.md, and AI usage
- Check Open questions before you assume an answer. It lists unsettled decisions and the interim posture to follow.
- If the standards conflict with this file or a request, stop and ask the repository maintainer.

CLAUDE.md holds only this line, as Agent instructions requires. Do not add the snippet to it.

CLAUDE.mdmarkdown
@AGENTS.md

What to read first

The snippet lists the work that needs a read first. This table maps each trigger to its standard, so a reviewer can check the list against the site.

Before you do this Read
Create or set up a repository, service, or project Principles, Team standards, Code ownership, Repository metadata, Documentation, Agent instructions
Use scaffolding or a project template Team standards and Open questions, where the web generator choice is unsettled
Choose a language, framework, library, or tool Principles, Team standards, Licensing
Model the domain or change an API contract Architecture
Change CI/CD, quality gates, or tests CI/CD, Quality gates, Testing, Cross-platform repositories
Review a change or assign owners Four-eyes, Code ownership
Release, roll back, or respond to an incident Release and incidents, CI/CD
Add errors, telemetry, logs, dashboards, or paging Observability
Add or remove a feature flag Feature flags
Touch secrets, permissions, or sign-in Security, Authentication, Audit responsibilities
Build user-facing UI or text Internationalisation, Design system
Record a design or a decision, or deviate from a standard Design documents, RFCs and ADRs, Exceptions
Write repository docs or agent instructions, or set up AI tooling Documentation, AI readiness
Anything the other rows leave out Open questions, then ask the Engineering Navigators

Access for agents

The site sits behind Cloudflare Access with Okta sign-in. A request without a valid session gets a 302 redirect to the sign-in page instead of the content.

  1. Install cloudflared. Follow Cloudflare’s download instructions.
  2. Run cloudflared access login https://engineering-standards.ninjatrader.dev once.
  3. Run it in an interactive session. The login opens a browser for Okta.

The snippet repeats the login command with --quiet --auto-close, so an agent that hits the redirect can start the sign-in itself.

Skill

The engineer-standards skill lives in NT-NinjaTrader/skills. It adds two commands:

  • /standards-ask answers a question and cites the standards pages it used.
  • /standards-check reviews a diff against the standards.

The skill carries its own copy of the guidance, and that copy can lag the site. Keep the AGENTS.md section even when you install the skill, so the agent reads the site first.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close