[GH-ISSUE #7654] [Bug] Translated setup guides omit the MCP output-profile option #4576

Open
opened 2026-10-31 00:50:56 +00:00 by bsakaguchi · 0 comments
Owner

Originally created by @coygeek on GitHub (Oct 28, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/7654

Before submitting

  • I searched the open and closed issues for a related report.
  • I removed credentials, tokens, private paths, and sensitive target data.

Area

Documentation

Observed behavior

Source-only documentation finding. Readers selecting any of the 22 translated README editions get the input-schema profile explanation in the agent setup section, then the next heading. The output-schema profile explanation present in English is missing. The translated setup sections therefore omit the full default and the compact/off choices for clients that limit the complete MCP catalog frame.

I ran this comparison at the source revision below:

grep -c 'REA_MCP_OUTPUT_SCHEMA_PROFILE' README.md docs/readme/README_*.md

The English edition returned one match; each of the 22 translated editions returned zero. I also checked the surrounding section structure. No MCP client, catalog rejection, or analysis workflow was exercised.

Reproduction

  1. Check out source revision 65f1c447344a423fa2785847dbcea1e9a9e2454a.
  2. Run the grep command above from the repository root. It prints README.md:1 and :0 for all translated editions. Its nonzero exit status reflects files without a match.
  3. Compare the agent setup sections in English and German: after the input-profile explanation, English has an output-profile paragraph; German goes directly to its next heading. The same section-structure check across all 22 editions shows the omission in each.

This is a deterministic comparison of committed documentation. The grep comparison and section checks were run in this verification.

Expected behavior

The translated agent setup sections should retain the English section's technical guidance about output advertisement defaults and the compact/off settings. The project's Translation corrections instructions identify English as the reference for README commands, requirements and analysis claims. This does not require identical wording or paragraph boundaries.

Impact and scope

P3: informational documentation omission affecting the 22 translated README entry points. It makes the output-profile option less discoverable beside the input-profile explanation. No failed setup, transport failure, lost result or runtime behavior change was demonstrated.

The complete documentation remains available: every translated edition links to the canonical MCP contracts guide, which explains all three output profiles. The linked installation and client-configuration guides provide another route. This report concerns missing localized onboarding guidance rather than absence of the setting from repository documentation.

REA version

Exact output of node scripts/rea.mjs --version:

6.8.0

Source revision: 65f1c447344a423fa2785847dbcea1e9a9e2454a.

Runtime and platform

Node.js v24.22.1; macOS 27.0.1; Darwin arm64. Version inspection used isolated HOME/XDG directories. No analysis provider or MCP server was started.

Target and artifact context

Source documentation only. No binary, session, analysis target or generated Evidence artifact applies.

Interface

Other

Earliest failure stage

Unknown

Relevant output or evidence

At the stated revision:

  • README.md:93-103 contains consecutive input- and output-profile explanations. The output-profile paragraph names REA_MCP_OUTPUT_SCHEMA_PROFILE=compact and off.
  • docs/readme/README_de.md:83-85 goes from input-profile prose directly to the next heading. The variable search returned zero for every docs/readme/README_*.md edition.
  • CONTRIBUTING.md:305-316 identifies the README translation sources and English technical reference.
  • docs/mcp-contracts.md:1469-1507 documents full/compact/off. All 22 translated editions contain a relative link to this guide. docs/client-configuration.md:230-237 also documents compact/off.
  • tests/conformance/readmeConsistency.test.ts:48-67 compares translated edition inventory and bash examples. Running npm run test:local -- tests/conformance/readmeConsistency.test.ts passed all nine tests. This checks the existing assertions, not prose completeness.
  • scripts/lib/docs-facts.mjs:135-158 compares normalized README link destinations. A paragraph containing no Markdown link is outside that comparison.

Analysis or suspected cause

Source-derived: commit 9085222ca1b5a636d4835a48b8bfed03da461b4f from merged PR #7218 adds the English explanation without changing any translated README. The existing consistency checks do not compare this prose. The reason translations were left unchanged was not established.

Additional context

Duplicate searches covered open and closed issues, all PR states and relevant comments. #4564 and #4570 concern other translated facts; #5085 concerns Korean updater guidance. The open language-sync PRs #3113 and #4139 do not add the output-profile variable. #5861 and #7155 concern MCP catalog size and general discoverability; neither identifies this translation omission. #2512 and #7218 cover the profile capability and English documentation.

No inspected maintainer guidance says translated READMEs may omit this technical setup guidance. Maintainer handling of #958, #5085 and #4570 supports technical alignment while allowing natural language wording and avoiding unnecessary repetition.

Originally created by @coygeek on GitHub (Oct 28, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/7654 ### Before submitting - [x] I searched the open and closed issues for a related report. - [x] I removed credentials, tokens, private paths, and sensitive target data. ### Area Documentation ### Observed behavior Source-only documentation finding. Readers selecting any of the 22 translated README editions get the input-schema profile explanation in the agent setup section, then the next heading. The output-schema profile explanation present in English is missing. The translated setup sections therefore omit the full default and the compact/off choices for clients that limit the complete MCP catalog frame. I ran this comparison at the source revision below: ```bash grep -c 'REA_MCP_OUTPUT_SCHEMA_PROFILE' README.md docs/readme/README_*.md ``` The English edition returned one match; each of the 22 translated editions returned zero. I also checked the surrounding section structure. No MCP client, catalog rejection, or analysis workflow was exercised. ### Reproduction 1. Check out source revision `65f1c447344a423fa2785847dbcea1e9a9e2454a`. 2. Run the grep command above from the repository root. It prints `README.md:1` and `:0` for all translated editions. Its nonzero exit status reflects files without a match. 3. Compare the agent setup sections in English and German: after the input-profile explanation, English has an output-profile paragraph; German goes directly to its next heading. The same section-structure check across all 22 editions shows the omission in each. This is a deterministic comparison of committed documentation. The grep comparison and section checks were run in this verification. ### Expected behavior The translated agent setup sections should retain the English section's technical guidance about output advertisement defaults and the compact/off settings. The project's Translation corrections instructions identify English as the reference for README commands, requirements and analysis claims. This does not require identical wording or paragraph boundaries. ### Impact and scope P3: informational documentation omission affecting the 22 translated README entry points. It makes the output-profile option less discoverable beside the input-profile explanation. No failed setup, transport failure, lost result or runtime behavior change was demonstrated. The complete documentation remains available: every translated edition links to the canonical MCP contracts guide, which explains all three output profiles. The linked installation and client-configuration guides provide another route. This report concerns missing localized onboarding guidance rather than absence of the setting from repository documentation. ### REA version Exact output of `node scripts/rea.mjs --version`: ```text 6.8.0 ``` Source revision: `65f1c447344a423fa2785847dbcea1e9a9e2454a`. ### Runtime and platform Node.js `v24.22.1`; macOS `27.0.1`; Darwin arm64. Version inspection used isolated HOME/XDG directories. No analysis provider or MCP server was started. ### Target and artifact context Source documentation only. No binary, session, analysis target or generated Evidence artifact applies. ### Interface Other ### Earliest failure stage Unknown ### Relevant output or evidence At the stated revision: - `README.md:93-103` contains consecutive input- and output-profile explanations. The output-profile paragraph names `REA_MCP_OUTPUT_SCHEMA_PROFILE=compact` and `off`. - `docs/readme/README_de.md:83-85` goes from input-profile prose directly to the next heading. The variable search returned zero for every `docs/readme/README_*.md` edition. - `CONTRIBUTING.md:305-316` identifies the README translation sources and English technical reference. - `docs/mcp-contracts.md:1469-1507` documents full/compact/off. All 22 translated editions contain a relative link to this guide. `docs/client-configuration.md:230-237` also documents compact/off. - `tests/conformance/readmeConsistency.test.ts:48-67` compares translated edition inventory and bash examples. Running `npm run test:local -- tests/conformance/readmeConsistency.test.ts` passed all nine tests. This checks the existing assertions, not prose completeness. - `scripts/lib/docs-facts.mjs:135-158` compares normalized README link destinations. A paragraph containing no Markdown link is outside that comparison. ### Analysis or suspected cause Source-derived: commit `9085222ca1b5a636d4835a48b8bfed03da461b4f` from merged PR #7218 adds the English explanation without changing any translated README. The existing consistency checks do not compare this prose. The reason translations were left unchanged was not established. ### Additional context Duplicate searches covered open and closed issues, all PR states and relevant comments. #4564 and #4570 concern other translated facts; #5085 concerns Korean updater guidance. The open language-sync PRs #3113 and #4139 do not add the output-profile variable. #5861 and #7155 concern MCP catalog size and general discoverability; neither identifies this translation omission. #2512 and #7218 cover the profile capability and English documentation. No inspected maintainer guidance says translated READMEs may omit this technical setup guidance. Maintainer handling of #958, #5085 and #4570 supports technical alignment while allowing natural language wording and avoiding unnecessary repetition.
Sign in to join this conversation.
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#4576
No description provided.