[PR #5162] [CLOSED] docs(codex): explain Moonshot schema recovery #6793

Closed
opened 2026-11-01 21:43:04 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/5162
Author: @Cross2pro
Created: 10/19/2026
Status: ❌ Closed

Base: main ← Head: fix/codex-kimi-schema-recovery


📝 Commits (1)

  • 8ef0001 docs(codex): explain Moonshot schema recovery

📊 Changes

2 files changed (+61 additions, -6 deletions)

View changed files

📝 docs/client-configuration.md (+52 -0)
📝 docs/mcp-contracts.md (+9 -6)

📄 Description

Summary

Fixes #5160.

Document recovery when Codex with kimi-k3 fails even on a greeting after REA connects: refresh the package that Codex actually launches and select the compact input schema profile. Correct the contract guide's obsolete description of selectively sharing input definitions.

Problem and expected behavior

An older cached REA schema triggers Moonshot's misleading steps infinite-recursion error. Current 6.7.0 already advertises self-contained inputs, but large full-profile schemas still exceed the model's size limit. Codex users need both upgrade and compact-profile instructions in their own host configuration; installing a new global executable or configuring Kimi Code does not update Codex's selected command.

Change and scope

Add Codex recovery steps, a mergeable TOML example, and the two observed error signatures. Link that section from the compact-profile guide. Describe the existing inline input/shared output policy accurately. The runtime fix is already on main in 5e30969cc5f1255d44ec7a1f1ca8dbac0af5e7c4; this PR does not duplicate it or change runtime behavior.

Contract and boundary impact

  • Semantic owner and earliest changed stage: client configuration and MCP schema documentation.
  • Contribution scope and maintainer decision: routine documentation correction within existing support; advance scope approval not applicable.
  • CLI/MCP, provider, Evidence, authority, and cleanup contracts: unchanged.
  • Generated metadata, package, and installation impact: none; two authored Markdown files only.

Expected effects:

  • Documentation or usability only; no target interaction.

Evidence and regression coverage

Executed through the configured Responses-compatible gateway with kimi-k3, requesting a short reply without tool invocation:

Advertised schema Observed result
Cached package reporting 6.3.0, native UI scenario, actual shared projection HTTP 400, exact steps recursion error
Same schema with acyclic local references expanded HTTP 200, response.completed
Official npm 6.7.0, native UI scenario, existing inline projection HTTP 200, response.completed
6.7.0 web capture comparison, full profile HTTP 400, schema exceeds maximum allowed size
Same 6.7.0 comparison schema, compact profile HTTP 200, response.completed

Codex logs place REA readiness between the first and second request starts, consistent with the observed first-success/second-failure pattern. Exact outgoing Codex requests were not captured. Package selector/cache mismatch, other gateways, complete-catalog acceptance, and model-driven tool execution remain unverified. No binary or analysis-engine execution was needed.

Validation performed

  • Live schema probes above — observed results recorded in #5160.
  • Node + smol-toml check of the added TOML block — parses; selects rea-agents@latest and compact; both cross-reference headings exist.
  • git diff --check — passed.
  • Pinned oxfmt@0.72.0 --check docs/client-configuration.md docs/mcp-contracts.md — passed, both files formatted correctly.

Full npm run check / npm run docs:check and a rendered documentation build have not been run in this sparse checkout. CI and human review remain pending.

Compatibility, safety, and release

Documentation only. The example is merged into the existing registration, preserves provider settings/timeouts, requires a backup, and reconnects the MCP server. No local user configuration was changed as part of this PR. No credentials, private URLs, or target data are included.

Author readiness

Human owner: @Cross2pro

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

Before merge

  • This PR addresses a concrete problem and links the related issue.
  • The PR has one focused outcome and a Conventional Commit title.
  • Human readiness declarations and applicable CI checks are complete.

Prepared with AI assistance; kept in draft for human ownership and review as required by CONTRIBUTING.md.


🔄 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/5162 **Author:** [@Cross2pro](https://github.com/Cross2pro) **Created:** 10/19/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `fix/codex-kimi-schema-recovery` --- ### 📝 Commits (1) - [`8ef0001`](https://github.com/morluto/rea/commit/8ef000128e7da71da01406ab285771e8ec16a956) docs(codex): explain Moonshot schema recovery ### 📊 Changes **2 files changed** (+61 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `docs/client-configuration.md` (+52 -0) 📝 `docs/mcp-contracts.md` (+9 -6) </details> ### 📄 Description ## Summary Fixes #5160. Document recovery when Codex with `kimi-k3` fails even on a greeting after REA connects: refresh the package that Codex actually launches and select the compact input schema profile. Correct the contract guide's obsolete description of selectively sharing input definitions. ## Problem and expected behavior An older cached REA schema triggers Moonshot's misleading `steps` infinite-recursion error. Current 6.7.0 already advertises self-contained inputs, but large full-profile schemas still exceed the model's size limit. Codex users need both upgrade and compact-profile instructions in their own host configuration; installing a new global executable or configuring Kimi Code does not update Codex's selected command. ## Change and scope Add Codex recovery steps, a mergeable TOML example, and the two observed error signatures. Link that section from the compact-profile guide. Describe the existing inline input/shared output policy accurately. The runtime fix is already on main in `5e30969cc5f1255d44ec7a1f1ca8dbac0af5e7c4`; this PR does not duplicate it or change runtime behavior. ## Contract and boundary impact - Semantic owner and earliest changed stage: client configuration and MCP schema documentation. - Contribution scope and maintainer decision: routine documentation correction within existing support; advance scope approval not applicable. - CLI/MCP, provider, Evidence, authority, and cleanup contracts: unchanged. - Generated metadata, package, and installation impact: none; two authored Markdown files only. Expected effects: - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage Executed through the configured Responses-compatible gateway with `kimi-k3`, requesting a short reply without tool invocation: | Advertised schema | Observed result | | --- | --- | | Cached package reporting 6.3.0, native UI scenario, actual shared projection | HTTP 400, exact `steps` recursion error | | Same schema with acyclic local references expanded | HTTP 200, `response.completed` | | Official npm 6.7.0, native UI scenario, existing inline projection | HTTP 200, `response.completed` | | 6.7.0 web capture comparison, full profile | HTTP 400, schema exceeds maximum allowed size | | Same 6.7.0 comparison schema, compact profile | HTTP 200, `response.completed` | Codex logs place REA readiness between the first and second request starts, consistent with the observed first-success/second-failure pattern. Exact outgoing Codex requests were not captured. Package selector/cache mismatch, other gateways, complete-catalog acceptance, and model-driven tool execution remain unverified. No binary or analysis-engine execution was needed. ## Validation performed - Live schema probes above — observed results recorded in #5160. - Node + `smol-toml` check of the added TOML block — parses; selects `rea-agents@latest` and `compact`; both cross-reference headings exist. - `git diff --check` — passed. - Pinned `oxfmt@0.72.0 --check docs/client-configuration.md docs/mcp-contracts.md` — passed, both files formatted correctly. Full `npm run check` / `npm run docs:check` and a rendered documentation build have not been run in this sparse checkout. CI and human review remain pending. ## Compatibility, safety, and release Documentation only. The example is merged into the existing registration, preserves provider settings/timeouts, requires a backup, and reconnects the MCP server. No local user configuration was changed as part of this PR. No credentials, private URLs, or target data are included. ## Author readiness Human owner: @Cross2pro - [ ] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [ ] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [ ] I declare this PR ready for initial maintainer review. ## Before merge - [x] This PR addresses a concrete problem and links the related issue. - [x] The PR has one focused outcome and a Conventional Commit title. - [ ] Human readiness declarations and applicable CI checks are complete. Prepared with AI assistance; kept in draft for human ownership and review as required by CONTRIBUTING.md. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-11-01 21:43:04 +00:00
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#6793
No description provided.