AGENTS.md standardization for all DBX Repositories

XMLWordPrintableJSON

    • Type: Improvement
    • Resolution: Unresolved
    • Priority: Major - P3
    • None
    • Component/s: AI/ML
    • None
    • ODM Changes Needed
    • Hide

      Summary of necessary driver changes

      • Introduce a repository-level AGENTS.md file.
      Show
      Summary of necessary driver changes Introduce a repository-level AGENTS.md file.
    • $i18n.getText("admin.common.words.hide")
      Key Status/Resolution FixVersion
      CDRIVER-6276 Backlog
      CXX-3440 Backlog
      CSHARP-5943 In Code Review
      GODRIVER-3845 Blocked
      JAVA-6146 In Progress
      NODE-7494 Blocked
      PYTHON-5768 In Code Review
      PHPLIB-1815 Backlog
      RUBY-3795 Done
      RUST-2388 Backlog
      INTPYTHON-939 In Code Review
      MONGOID-5929 Done
      PHPORM-478 Backlog
      $i18n.getText("admin.common.words.show")
      #scriptField, #scriptField *{ border: 1px solid black; } #scriptField{ border-collapse: collapse; } #scriptField td { text-align: center; /* Center-align text in table cells */ } #scriptField td.key { text-align: left; /* Left-align text in the Key column */ } #scriptField a { text-decoration: none; /* Remove underlines from links */ border: none; /* Remove border from links */ } /* Add green background color to cells with FixVersion */ #scriptField td.hasFixVersion { background-color: #00FF00; /* Green color code */ } #scriptField td.willNotDo { background-color: #FF0000; /* Red color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } Key Status/Resolution FixVersion CDRIVER-6276 Backlog CXX-3440 Backlog CSHARP-5943 In Code Review GODRIVER-3845 Blocked JAVA-6146 In Progress NODE-7494 Blocked PYTHON-5768 In Code Review PHPLIB-1815 Backlog RUBY-3795 Done RUST-2388 Backlog INTPYTHON-939 In Code Review MONGOID-5929 Done PHPORM-478 Backlog

      Teams are introducing AGENTS.md files, which give Claude Code and other agents consistent, guidance for repos or sections of the codebase. We need generalized guidance for how to best set up such files across all drivers and ODM repos. This does not imply one global file, or a set of fixed requirements that each project is required to meet, but rather an evolving set of best-practices. Individual teams are free to selectively implement those best practices into their own repositories. The guidance should include information on what should be present, how we validate what should be added, how we remove items and validate their removal.

      Anthropic documents AGENTS.md as the place to capture persistent project context such as coding standards, workflow rules, architectural decisions, build/test commands, repository etiquette, and non-obvious gotchas, especially the information Claude cannot reliably infer from code alone. Extensive documentation must be balanced against the need to avoid extensive context, as well as redundant or even contradictory instructions.

      Standardizing this across repositories would improve the quality and consistency of AI-assisted contributions by reducing repeated prompt setup, making repo conventions explicit, and ensuring shared instructions travel with the codebase in source control. Because project AGENTS.md files are team-shared and versioned in git, they can become a durable layer of operational knowledge that helps onboard contributors faster and keeps Agents (claude / copilot etal) aligned with each repository’s expectations over time.

      Note that this should apply to any DBX repository such as:

      • specifications
      • drivers
      • ODMs
      • libraries
      • tools

      Why AGENTS.md over CLAUDE.md: See: https://wiki.corp.mongodb.com/spaces/MMS/pages/499158370/Making+a+Repo+Agent+Ready

      We want this process to be iterative, so after this is ready for teams to implement, file a follow-up DRIVERS ticket for Q4 to revisit and reassess.

            Assignee:
            Unassigned
            Reporter:
            Alex Bevilacqua
            Votes:
            0 Vote for this issue
            Watchers:
            7 Start watching this issue

              Created:
              Updated: