morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #658] [MERGED] docs(installation): pin manual MCP registration to the release version #2143

New issue

Closed

opened 2026-10-16 21:14:49 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-16 21:14:49 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/658
Author: @kaoru0822-kitauji
Created: 10/6/2026
Status: ✅ Merged
Merged: 10/6/2026
Merged by: @N0zoM1z0

Base: main ← Head: docs/manual-mcp-version-pin

📝 Commits (1)

0af888c docs(installation): pin manual MCP registration to the release version

📊 Changes

4 files changed (+18 additions, -8 deletions)

View changed files

📝 docs/installation.md (+9 -4)
📝 release-please-config.json (+1 -0)
📝 tests/conformance/readmeConsistency.test.ts (+1 -1)
📝 tests/conformance/releaseConfiguration.test.ts (+7 -3)

📄 Description

Summary

Fixes #653.

Pin the installation guide's manual MCP registration to the current release instead of @latest, so copying the example produces a registration that rea doctor accepts.

Problem and expected behavior

The guide recommends ["-y", "rea-agents@latest", "mcp"], while setup and doctor require an exact release version for persistent registrations. The copied example is reported as stale even when latest resolves to the running version.

The example now uses rea-agents@4.0.1 and explains how current setup refreshes older registrations.

Change and scope

Correct the manual JSON example and exact-version guidance.
Add release-please version markers and register docs/installation.md as an extra release file, keeping the new pin current on future releases.
Update the existing documentation consistency assertion to compare with PRODUCT_IDENTITY.registrationPackageSpecifier.
Include the installation guide in the existing release-file and version-marker conformance coverage.

Contract and boundary impact

Semantic owner: installation documentation and release-managed version examples.
CLI/MCP, provider, bridge, target-format, platform, evidence and artifact contracts: unchanged.
Process execution, authorization, cleanup and containment: unchanged.
Generated product metadata and package runtime: unchanged. Release metadata now updates the guide's example alongside the READMEs.

Evidence and regression coverage

Copied the original and corrected JSON examples unchanged into isolated Cursor configurations and ran rea doctor --client cursor --skill=false --json:

Example	Registration	Healthy	Exit
Original `@latest`	stale	false	1
Exact current version	aligned	true	0

Doctor left both configuration files unchanged; temporary fixtures were removed. These runtime checks used the exact upstream CI build from run 37412719487, commit 19f8cdd. The newer base fc80ea88 changes documentation only.

The updated conformance tests fail in three places against the original guide/release configuration: package pin, release-file membership, and version marker. All 18 tests pass with this change.

Validation performed

npm run test:focused -- tests/conformance/readmeConsistency.test.ts tests/conformance/releaseConfiguration.test.ts — 18 passed, including a final run on base fc80ea88; used a writable temporary TMPDIR.
npm run docs:check:built — passed using the upstream CI build.
npm run lint and npm run knip — passed; lint reports existing repository warnings.
Oxfmt checks for all four changed files and git diff --check — passed.
npm run check, npm run verify:package, and npm pack --dry-run — attempted, but could not complete in this execution environment. The native TypeScript compiler fails to resolve /proc/self/exe; a full-tree formatting attempt also encountered unavailable process-memory information. Full local static/package success is not claimed. Hosted CI completed successfully; the local environment limitation did not reproduce there.
Hosted CI run 37419420613 — all 18 checks passed, including build, static checks, docs, all four test shards and coverage aggregate, Linux/macOS package integration, Windows capability/package verification, and Apple artifact CLI/MCP E2E.

Compatibility, safety, and release

No breaking change or migration. Real Hopper/Ghidra and browser verification were not run locally: this changes a manual configuration example, its release updater, and conformance assertions. No provider implementation or installed-client configuration is modified.

Prepared with AI assistance.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/658 **Author:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Created:** 10/6/2026 **Status:** ✅ Merged **Merged:** 10/6/2026 **Merged by:** [@N0zoM1z0](https://github.com/N0zoM1z0) **Base:** `main` ← **Head:** `docs/manual-mcp-version-pin` --- ### 📝 Commits (1) - [`0af888c`](https://github.com/morluto/rea/commit/0af888cbb5e696aa24da1693eefde114538c07dc) docs(installation): pin manual MCP registration to the release version ### 📊 Changes **4 files changed** (+18 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `docs/installation.md` (+9 -4) 📝 `release-please-config.json` (+1 -0) 📝 `tests/conformance/readmeConsistency.test.ts` (+1 -1) 📝 `tests/conformance/releaseConfiguration.test.ts` (+7 -3) </details> ### 📄 Description ## Summary Fixes #653. Pin the installation guide's manual MCP registration to the current release instead of `@latest`, so copying the example produces a registration that `rea doctor` accepts. ## Problem and expected behavior The guide recommends `["-y", "rea-agents@latest", "mcp"]`, while setup and doctor require an exact release version for persistent registrations. The copied example is reported as stale even when latest resolves to the running version. The example now uses `rea-agents@4.0.1` and explains how current setup refreshes older registrations. ## Change and scope - Correct the manual JSON example and exact-version guidance. - Add release-please version markers and register `docs/installation.md` as an extra release file, keeping the new pin current on future releases. - Update the existing documentation consistency assertion to compare with `PRODUCT_IDENTITY.registrationPackageSpecifier`. - Include the installation guide in the existing release-file and version-marker conformance coverage. ## Contract and boundary impact - Semantic owner: installation documentation and release-managed version examples. - CLI/MCP, provider, bridge, target-format, platform, evidence and artifact contracts: unchanged. - Process execution, authorization, cleanup and containment: unchanged. - Generated product metadata and package runtime: unchanged. Release metadata now updates the guide's example alongside the READMEs. ## Evidence and regression coverage Copied the original and corrected JSON examples unchanged into isolated Cursor configurations and ran `rea doctor --client cursor --skill=false --json`: | Example | Registration | Healthy | Exit | | --- | --- | --- | --- | | Original `@latest` | stale | false | 1 | | Exact current version | aligned | true | 0 | Doctor left both configuration files unchanged; temporary fixtures were removed. These runtime checks used the exact upstream CI build from [run 37412719487](https://github.com/morluto/rea/actions/runs/37412719487), commit `19f8cdd`. The newer base `fc80ea88` changes documentation only. The updated conformance tests fail in three places against the original guide/release configuration: package pin, release-file membership, and version marker. All 18 tests pass with this change. ## Validation performed - `npm run test:focused -- tests/conformance/readmeConsistency.test.ts tests/conformance/releaseConfiguration.test.ts` — 18 passed, including a final run on base `fc80ea88`; used a writable temporary `TMPDIR`. - `npm run docs:check:built` — passed using the upstream CI build. - `npm run lint` and `npm run knip` — passed; lint reports existing repository warnings. - Oxfmt checks for all four changed files and `git diff --check` — passed. - `npm run check`, `npm run verify:package`, and `npm pack --dry-run` — attempted, but could not complete in this execution environment. The native TypeScript compiler fails to resolve `/proc/self/exe`; a full-tree formatting attempt also encountered unavailable process-memory information. Full local static/package success is not claimed. Hosted CI completed successfully; the local environment limitation did not reproduce there. - [Hosted CI run 37419420613](https://github.com/morluto/rea/actions/runs/37419420613) — all 18 checks passed, including build, static checks, docs, all four test shards and coverage aggregate, Linux/macOS package integration, Windows capability/package verification, and Apple artifact CLI/MCP E2E. ## Compatibility, safety, and release No breaking change or migration. Real Hopper/Ghidra and browser verification were not run locally: this changes a manual configuration example, its release updater, and conformance assertions. No provider implementation or installed-client configuration is modified. Prepared with AI assistance. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-16 21:14:49 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-10-31 01:01:28 +00:00

[PR #2145] [MERGED] fix(jeb): confine an invalid REA_JEB_MCP_URL to the JEB tools #5057

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#2143

No description provided.

Rows
Columns