Sync Agents Docs
Documentssync-agents-docsSync Agents Docs is an Agent Skill for documents published in the mongodb/mongo-java-driver repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Sync AGENTS.md files, skills, and references after buildSrc or convention changes. Use after modifying build plugins, formatting rules, testing conventions, or task names to keep documentation consistent.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/mongodb/mongo-java-driver/blob/HEAD/.agents/skills/sync-agents-docs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/sync-agents-docs, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Sync Documentation After Build Changes
This is a manual checklist — disable-model-invocation: true means agents cannot execute it autonomously.
Human developers should walk through this after buildSrc changes.
After modifying buildSrc or build conventions, check whether AGENTS.md files, skills, and references need updating.
Review your changes against the checklist below and update only the affected files.
Checklist
| What changed | What to update |
|---|---|
Formatting conventions (spotless.gradle.kts) | Root AGENTS.md Style section, style-reference reference, affected module AGENTS.md files |
| Convention plugins added or removed | buildSrc/AGENTS.md plugin table, root AGENTS.md if build commands or workflow changed |
Testing conventions (testing-*.gradle.kts) | Root AGENTS.md Testing section, testing-guide reference, affected module AGENTS.md files |
| Project plugins added or removed | buildSrc/AGENTS.md project plugin table |
| Build commands or task names changed | Root AGENTS.md Build and Before Submitting sections, evergreen skill, module AGENTS.md files |
| CI/CD or publishing changes | evergreen skill |
How to use
- Review the diff of your buildSrc changes
- Walk through the checklist above — only rows matching your changes need action
- Update the affected files, keeping changes minimal and accurate
- Verify no stale references remain (e.g., renamed tasks, removed plugins)