AGENT.md · Example Payload

Agent Md Example

A REST API built with Node.js and Express serving mobile and web clients.

AI AgentsAI CopilotCoding StandardsDeveloper WorkflowConfigurationStandards

Agent Md Example is an example object payload from AGENT.md, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

projectdescriptioninstructionsstackconventionstoolsavoidfocuscontext

Example Payload

agent-md-example.json Raw ↑ 
{
  "project": "my-api-project",
  "description": "A REST API built with Node.js and Express serving mobile and web clients.",
  "instructions": [
    "Follow the existing code style and patterns",
    "Write tests for all new functionality",
    "Keep functions small and focused"
  ],
  "stack": {
    "language": "JavaScript",
    "framework": "Express",
    "runtime": "Node.js 20",
    "package_manager": "npm"
  },
  "conventions": {
    "style": "ESLint with Airbnb config",
    "naming": "camelCase for variables, PascalCase for classes",
    "testing": "Jest with coverage > 80%",
    "documentation": "JSDoc for all public functions"
  },
  "tools": [
    "eslint",
    "jest",
    "prettier",
    "husky"
  ],
  "avoid": [
    "jQuery",
    "callbacks (use async/await)",
    "var (use const/let)"
  ],
  "focus": [
    "src/",
    "tests/"
  ],
  "context": "This project is a microservice in a larger distributed system."
}