Skip to content

Added AGENTS.md instructions and SKILLS.md#1921

Open
rozza wants to merge 10 commits intomongodb:mainfrom
rozza:JAVA-6143
Open

Added AGENTS.md instructions and SKILLS.md#1921
rozza wants to merge 10 commits intomongodb:mainfrom
rozza:JAVA-6143

Conversation

@rozza
Copy link
Copy Markdown
Member

@rozza rozza commented Mar 23, 2026 •
edited
Loading

Initial implementation of AGENTS.md and SKILLS.md for the MongoDB Java Driver Repo

JAVA-6143

@rozza rozza requested a review from Copilot March 23, 2026 17:29

This comment was marked as resolved.

Sign in to view

@rozza rozza requested a review from Copilot March 24, 2026 12:07

This comment was marked as resolved.

Sign in to view

@rozza
Added CLAUDE.md instructions
935f140 
A global general instruction and one per project

JAVA-6143
@rozza rozza requested a review from Copilot March 24, 2026 13:23

This comment was marked as outdated.

Sign in to view

@rozza rozza requested a review from Copilot March 24, 2026 15:31

This comment was marked as outdated.

Sign in to view

@rozza rozza changed the title Added CLAUDE.md instructions Added AGENTS.md instructions and SKILLS.md Mar 24, 2026
@rozza
Copy link
Copy Markdown
Member Author

rozza commented Mar 24, 2026 •
edited
Loading

Followed general guidelines from: https://wiki.corp.mongodb.com/spaces/MMS/pages/499158370/Making+a+Repo+Agent+Ready
Also used glean to review the PR and provide suggested feedback.

AGENTS.md: The Constitution

AGENTS.md is a markdown file at the root of the repository. Every AI agent — Augment, Claude Code, Cursor — reads it automatically at the start of every session.

This means every token in AGENTS.md is loaded into the agent's context window every single time. The context window has a budget. Frontier models reliably follow ~150-200 instructions, and tool system prompts consume a significant share before your AGENTS.md even loads. Overstuffing AGENTS.md degrades the quality of all instructions — not selectively. Brevity is load-bearing.

What belongs in AGENTS.md

Core development principles (style, testing, safety rules)
Architecture overview (tech stack, build system)
Conventions that apply to every task, every session

What does NOT belong in AGENTS.md

Detailed workflows for specific tasks (use a skill)
Reference documentation (use a skill with a references/ directory)
Long examples or templates (use a skill)
If the information is only relevant to 1 in 10 sessions, it should not be in AGENTS.md. It should be a skill.

@rozza rozza requested a review from Copilot March 24, 2026 17:27
Copilot AI reviewed Mar 24, 2026
View reviewed changes
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 52 out of 53 changed files in this pull request and generated 5 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@rozza rozza requested a review from Copilot March 25, 2026 11:37

This comment was marked as off-topic.

Sign in to view

@rozza rozza marked this pull request as ready for review March 25, 2026 15:29
@rozza rozza requested a review from a team as a code owner March 25, 2026 15:29
@rozza rozza requested review from katcharov and strogiyotec and removed request for strogiyotec March 25, 2026 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@katcharov katcharov Awaiting requested review from katcharov

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rozza