Introduce a standardized AGENTS.md into 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 Needs Triage
      CXX-3440 Needs Triage
      CSHARP-5943 Needs Triage
      GODRIVER-3845 Needs Triage
      JAVA-6146 In Progress
      NODE-7494 Needs Triage
      PYTHON-5768 Needs Triage
      PHPLIB-1815 Needs Triage
      RUBY-3795 Needs Triage
      RUST-2388 Backlog
      INTPYTHON-939 Needs Triage
      MONGOID-5929 Needs Triage
      PHPORM-478 Needs Triage
      $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 Needs Triage CXX-3440 Needs Triage CSHARP-5943 Needs Triage GODRIVER-3845 Needs Triage JAVA-6146 In Progress NODE-7494 Needs Triage PYTHON-5768 Needs Triage PHPLIB-1815 Needs Triage RUBY-3795 Needs Triage RUST-2388 Backlog INTPYTHON-939 Needs Triage MONGOID-5929 Needs Triage PHPORM-478 Needs Triage

      Introduce a repository-level AGENTS.md file across all drivers and ODM repos to give Claude Code consistent, repo-specific guidance at the start of every session. 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.

      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

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

              Created:
              Updated: