#10670: Add AGENTS.md for AI coding assistant guidance

[chetankh239]

Addresses mosip/mosip-config#10670 — adds a root AGENTS.md hub plus per-module AGENTS.md guides (mock-identity-system, mock-relying-party-service, mock-relying-party-ui, mock-relying-party-ui-esim, partner-onboarder) documenting purpose, layout, build/run/test commands, configuration, and agent do/do-not rules for AI coding assistants.

Summary by CodeRabbit

• Documentation
  • Added comprehensive development guides for the repository and its modules.
  • Documented setup, testing, configuration, project structure, workflows, and contribution guidelines.
  • Clarified service capabilities, endpoint usage, runtime configuration, Docker workflows, and troubleshooting steps.
  • Added guidance for onboarding workflows, report verification, and operational support.
  • Reinforced security practices, secret handling, mock-only usage, module isolation, and deployment considerations.

[coderabbitai]

Walkthrough

Added root and module-level AGENTS.md files. The documentation covers repository structure, development workflows, module commands, configuration, testing, CI, security constraints, and contribution rules.

Changes

Repository agent guidance

Layer / File(s)	Summary
Repository-wide rules AGENTS.md	Documents repository structure, technology stacks, build and test commands, configuration, CI workflows, pull-request practices, module isolation, mock-only usage, and secret handling.
Mock service and UI guides mock-identity-system/AGENTS.md, mock-relying-party-service/AGENTS.md, mock-relying-party-ui-esim/AGENTS.md, mock-relying-party-ui/AGENTS.md	Documents module layouts, startup and test commands, endpoints, runtime configuration, Docker usage, dependency separation, and module-specific security rules.
Partner onboarder guide partner-onboarder/AGENTS.md	Documents onboarding scripts, installation, report verification, troubleshooting, shared-cluster safety, and credential handling.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Poem

New guides mark the paths,
Commands glow clear and bright,
Secrets stay guarded,
Mock services take flight,
Agents read, then build right.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the addition of root and module-specific AGENTS.md guidance for AI coding assistants.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 124-125: Update the root testing/build guidance near “Run the
relevant module's tests/build” to avoid prescribing npm test for every
Node/React module. Direct contributors to use each module’s documented commands,
including the module-specific guidance in mock-relying-party-service/AGENTS.md,
while retaining the Java module’s Maven command and applicable Node/React build
instructions.

In `@mock-identity-system/AGENTS.md`:
- Around line 31-35: Update the local setup command in AGENTS.md to reference
docker-compose/dependent-docker-compose.yml from the repository root, while
leaving the Maven command and surrounding setup instructions unchanged.

In `@mock-relying-party-ui-esim/AGENTS.md`:
- Around line 31-47: Update the Docker example in AGENTS.md to use
MOCK_RELYING_PARTY_SERVER_URL instead of MOCK_RELYING_PARTY_BASE_URL, matching
the variable consumed by the Dockerfile and UI. Keep the example’s value and all
other environment variables unchanged.

In `@partner-onboarder/AGENTS.md`:
- Around line 7-11: Update the onboarding documentation in AGENTS.md and the
“Esignet K8 cluster” wording in install.sh to explicitly target non-production
eSignet/Kubernetes clusters only, replacing language that could imply production
support while preserving the existing onboarding purpose and identity-plugin
context.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f0fa5550-2081-4c42-8ffb-ccfb0fb92abf

📥 Commits

Reviewing files that changed from the base of the PR and between 98d748c and de77647.

📒 Files selected for processing (6)

• AGENTS.md
• mock-identity-system/AGENTS.md
• mock-relying-party-service/AGENTS.md
• mock-relying-party-ui-esim/AGENTS.md
• mock-relying-party-ui/AGENTS.md
• partner-onboarder/AGENTS.md

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

AGENTS.md (1)

167-171: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Cover partner-onboarder in the validation and configuration rules.

Lines 167-171 list only Maven and npm validation and environment variables or properties files. However, Lines 29, 49, and 97 define partner-onboarder as a shell/Helm module configured through partner-onboarder/values.yaml. Agents can skip its documented validation or use the wrong configuration surface.

Add the shell/Helm validation command and include values.yaml in this rule.

As per coding guidelines, each changed module must use its own documented build/test workflow.

Proposed wording

-2. Build and test the specific module you changed before proposing a PR (Maven for
-   `mock-identity-system`, `npm` for the Node/React modules).
-3. Keep any new configuration documented as environment variables or properties files
-   consistent with the patterns already used in that module (no new secrets committed to the
-   repo).
+2. Build and test the specific module you changed before proposing a PR, using its
+   documented workflow: Maven for `mock-identity-system`, npm for the Node/React
+   modules, and the shell/Helm commands in `partner-onboarder/AGENTS.md` for
+   `partner-onboarder`.
+3. Keep new configuration documented in the module's existing configuration surface,
+   including environment variables, properties, UI runtime configuration, or
+   `partner-onboarder/values.yaml`, as applicable. Do not commit secrets.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@AGENTS.md` around lines 167 - 171, Update the module validation and
configuration guidance around the listed Maven/npm workflows to also cover the
partner-onboarder shell/Helm module: specify its documented shell/Helm
validation command and recognize partner-onboarder/values.yaml as a valid
configuration surface, while preserving the existing module-specific workflow
and no-secrets requirements.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@AGENTS.md`:
- Around line 167-171: Update the module validation and configuration guidance
around the listed Maven/npm workflows to also cover the partner-onboarder
shell/Helm module: specify its documented shell/Helm validation command and
recognize partner-onboarder/values.yaml as a valid configuration surface, while
preserving the existing module-specific workflow and no-secrets requirements.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 061332b5-5a26-4c74-a16b-467e8b7792dd

📥 Commits

Reviewing files that changed from the base of the PR and between de77647 and 563baf1.

📒 Files selected for processing (4)

• AGENTS.md
• mock-identity-system/AGENTS.md
• mock-relying-party-ui-esim/AGENTS.md
• partner-onboarder/AGENTS.md

[zesu22]

ok