AGENTS.md · Schema

AgentsMdFile

Representation of an AGENTS.md file's structured content providing context and instructions to AI coding agents.

AI AgentsAI CopilotCoding StandardsDeveloper WorkflowOpen StandardDocumentation

Properties

Name Type Description
filename string The filename, typically AGENTS.md.
location string File path within the repository.
project_name string Name of the project or subproject this file applies to.
description string Brief description of the project's purpose and architecture.
build_commands array Commands for building the project.
test_commands array Commands for running tests.
lint_commands array Commands for linting and formatting code.
coding_standards array Coding conventions and style guidelines for the project.
security_notes array Security considerations and sensitive file locations agents should be aware of.
created string Date the AGENTS.md file was created.
modified string Date the AGENTS.md file was last modified.
View JSON Schema on GitHub