mongodb-mcp: Instructions file for Codex

Repository Guidelines

Contributor Notes

• Keep source code, comments, documentation, and commit messages in English.
• Run npm run build and npx eslint . before publishing changes to ensure type-checking and linting stay green.
• When formatting or refactoring code, default to running npx eslint --fix (without dry-run) so lintable issues are auto-corrected early.
• Maintain README.md in English and README-ru.md in Russian so both stay aligned with the MongoDB MCP feature set.
• Ensure every data-mutating MCP tool description explicitly instructs clients to re-fetch the updated entity and verify that requested properties were applied.

Planning Workflow

• Always create a plan document before implementation for non-trivial tasks (new features, significant refactoring, or multi-file changes).
• Plan documents must be stored in temp/ directory with descriptive filenames (e.g., temp/issue-star-tools-plan.md).
• All plan documents must include a Table of Contents (TOC) for easy navigation.
• Rule: Documentation changes come before code changes - When a task requires both adding new rules/guidelines and implementing them:
  1. First, update AGENTS.md with new rules and best practices
  2. Then, implement the code changes following those rules
  3. This ensures guidelines are documented before they become implicit knowledge
• Plan document structure should include:
  • Overview and motivation
  • Detailed implementation steps with file references and line numbers where applicable
  • Type definitions and interfaces
  • API endpoints and parameters
  • Error handling strategy
  • Testing approach
  • Files to be modified with estimated line counts
• Use the plan as a checklist during implementation - mark sections as completed as you progress.

Documentation Guidelines

Language Policy

• This AGENTS.md must always be written in English. Do not localize or translate this file.
• Examples, code snippets, and rule text in this file should remain in English for consistency across all contributors and tools.
• STRICTLY FORBIDDEN: Never use emojis in any documentation, commit messages, code comments, or tool responses. This applies to:
  • All Markdown files (README.md, README-ru.md, CHANGELOG.md, etc.)
  • Git commit messages
  • Code comments and documentation strings
  • MCP tool descriptions and responses
  • Release notes and GitHub releases
  • Any other project documentation
• Keep documentation clear, concise, and technically accurate.
• Focus on technical content rather than decorative elements.
• Table of Contents (TOC) Policy:
  • TOC is required for all Markdown files intended for human readers (e.g., README.md, README-ru.md, user-facing documentation, guides).
  • TOC is not required for instruction files for AI agents (e.g., AGENTS.md, CLAUDE.md, or similar AI instruction files).
  • Rationale: AI agents can navigate documents without TOC; humans benefit from quick navigation.
• TOC should use standard Markdown anchor links (e.g., [Overview](#overview)).
• Include all level 2 (##) and level 3 (###) headers in the TOC for easy navigation.
• Update the TOC whenever document structure changes (new sections, renamed headers, etc.).
• Example TOC format:

  ## Table of Contents
  - [Section 1](#section-1)
    - [Subsection 1.1](#subsection-11)
  - [Section 2](#section-2)