Skip to content

Comments

docs: Add AGENTS.md for AI coding agent guidance#5541

Open
morozow wants to merge 1 commit intokirodotdev:mainfrom
worktif:feature/agents/agents-md-dedicated-predictable-agents-md-place-to-provide-kiro-agents-context
Open

docs: Add AGENTS.md for AI coding agent guidance#5541
morozow wants to merge 1 commit intokirodotdev:mainfrom
worktif:feature/agents/agents-md-dedicated-predictable-agents-md-place-to-provide-kiro-agents-context

Conversation

@morozow
Copy link

@morozow morozow commented Feb 10, 2026

  • Add AGENTS.md with detailed agent scope, identity, and primary goals
  • Document project overview including purpose, core domains, and critical invariants
  • Include environment setup requirements (Node.js 20.x, TypeScript 5.3.3, npm)
  • Provide complete repository structure map and architecture overview
  • List all key entrypoints for automation scripts and GitHub Actions workflows
  • Define coding conventions including TypeScript strict mode, ES modules, and import patterns
  • Establish testing strategy with unit and integration test patterns
  • Document workflow rules for branching, commits, and pull requests
  • Specify safety requirements for secrets, environment variables, and destructive operations
  • Include security requirements for input sanitization and prompt injection detection
  • Document AWS Bedrock integration details and GitHub API requirements
  • Provide reference commands for building, testing, and local development

Issue #, if available: ––

Description of changes:

AGENTS.md for AI coding agent guidance

This PR adds an AGENTS.md file to provide structured guidance for AI coding agents working in this repository.

What is AGENTS.md?

AGENTS.md is a simple, open format for guiding coding agents, used by over 60k open-source projects. It serves as a "README for agents" — a dedicated, predictable place to provide context and instructions that help AI coding agents work effectively on your project.

AGENTS.md is now stewarded by the Agentic AI Foundation under the Linux Foundation.

Why AGENTS.md?

  • Predictable location: Gives agents a clear, consistent place for instructions
  • Cross-agent compatibility: Works across many AI coding agents (OpenAI Codex, Cursor, Amp, Jules from Google, Factory, and others)
  • Open standard: Not proprietary — designed to work for anyone building or using coding agents

What this PR adds

The AGENTS.md file includes:

Section Description
Project overview Purpose, domains, critical invariants
Environment Node.js 20.x, TypeScript 5.3.3, npm
Setup commands Install, build, test, clean
Architecture map Directory structure, key entrypoints
Coding conventions Style, error handling, logging
Testing strategy Test locations, patterns, commands
Safety & secrets Security requirements, forbidden operations
Constraints Do-not-touch areas, thresholds
Definition of Done Checklist for task completion

How to test

cd scripts
npm install
npm run build
npm test

References

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

- Add AGENTS.md with detailed agent scope, identity, and primary goals
- Document project overview including purpose, core domains, and critical invariants
- Include environment setup requirements (Node.js 20.x, TypeScript 5.3.3, npm)
- Provide complete repository structure map and architecture overview
- List all key entrypoints for automation scripts and GitHub Actions workflows
- Define coding conventions including TypeScript strict mode, ES modules, and import patterns
- Establish testing strategy with unit and integration test patterns
- Document workflow rules for branching, commits, and pull requests
- Specify safety requirements for secrets, environment variables, and destructive operations
- Include security requirements for input sanitization and prompt injection detection
- Document AWS Bedrock integration details and GitHub API requirements
- Provide reference commands for building, testing, and local development
@morozow morozow requested review from a team as code owners February 10, 2026 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant