Skip to content

chore(NODE-7481): add AGENTS.md for cross-tool agent guidance#4929

Open
tadjik1 wants to merge 5 commits intomainfrom
NODE-7481
Open

chore(NODE-7481): add AGENTS.md for cross-tool agent guidance#4929
tadjik1 wants to merge 5 commits intomainfrom
NODE-7481

Conversation

@tadjik1
Copy link
Copy Markdown
Member

@tadjik1 tadjik1 commented Apr 27, 2026

Description

Summary of Changes

Generic AGENTS.md file for your local agent.

Double check the following

  • Lint is passing (npm run check:lint)
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@tadjik1 tadjik1 marked this pull request as ready for review April 27, 2026 15:08
@tadjik1 tadjik1 requested a review from a team as a code owner April 27, 2026 15:08
Copilot AI review requested due to automatic review settings April 27, 2026 15:08
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an AGENTS.md file to provide cross-tool guidance for AI coding agents working in the MongoDB Node.js driver repository.

Changes:

  • Introduces a standardized set of build/lint/test commands for agents to use.
  • Documents high-level architecture and key source/test directory layout.
  • Captures repo-specific code conventions (lint-enforced and team conventions) and commit message format.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
@PavelSafronov PavelSafronov self-assigned this Apr 27, 2026
Copy link
Copy Markdown
Contributor

@PavelSafronov PavelSafronov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome start!

Some things I would love to see addressed in this readme:

  1. specifications, reference https://github.com/mongodb/specifications somehow, mention that this is the source of truth
  2. mention other repos that our team owns that are relevant, such as js-bson or kerberos

Comment thread AGENTS.md
Comment thread AGENTS.md

This is the official MongoDB Node.js driver (`mongodb` npm package). It provides a TypeScript/JavaScript interface for applications to interact with MongoDB deployments. The driver implements the cross-driver MongoDB specifications.

## Related Repositories
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@PavelSafronov thanks for the suggestion! List of related repositories here.

@tadjik1 tadjik1 requested a review from PavelSafronov April 30, 2026 12:07
Comment thread AGENTS.md
@@ -0,0 +1,121 @@
# AGENTS.md
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to include a claude.md that points to this file, also

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

@dariakp
Copy link
Copy Markdown
Contributor

dariakp commented Apr 30, 2026

I tried to run it through claude for best practices, and here's its suggestion for tightening things:
https://github.com/mongodb/node-mongodb-native/pull/4931/changes

Any thoughts from @tadjik1 @PavelSafronov ?

@PavelSafronov
Copy link
Copy Markdown
Contributor

I tried to run it through claude for best practices, and here's its suggestion for tightening things: https://github.com/mongodb/node-mongodb-native/pull/4931/changes

Any thoughts from @tadjik1 @PavelSafronov ?

I replied on the PR.
Two of the additions I've marked as a good idea, would be nice to port those into this PR.

@tadjik1
Copy link
Copy Markdown
Member Author

tadjik1 commented May 4, 2026

Thanks! I copied those suggestions (about generated code and public surface of the library) over. Please take a look.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread AGENTS.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.

4 participants