morluto/rea

Fork 0

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

[PR #7202] [CLOSED] docs(mcp): describe compact input advertisements as the default #7712

New issue

Closed

opened 2026-11-03 13:39:49 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-11-03 13:39:49 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/7202
Author: @XiaoBinGan
Created: 10/26/2026
Status: ❌ Closed

Base: main ← Head: docs/mcp-input-schema-default

📝 Commits (1)

10d1218 docs(mcp): describe compact input advertisements as the default

📊 Changes

1 file changed (+8 additions, -7 deletions)

View changed files

📝 docs/client-configuration.md (+8 -7)

📄 Description

Summary

The Claude Code section tells readers to add "REA_MCP_INPUT_SCHEMA_PROFILE": "compact" because compact is not the default. Compact became the default in #5975 (perf(mcp)!: default to compact input schema advertisements, merged 2026-10-21).

Problem and expected behavior

docs/client-configuration.md says the measured payload is the "default profile", then tells readers to add the compact override to shrink it:

with 172 tools, that payload measured about 496 KB with the default profile and about 290 KB with compact.
To shrink the upfront catalog, add "REA_MCP_INPUT_SCHEMA_PROFILE": "compact" to the env object of the mcpServers.rea entry ... then restart Claude Code.

The resolver makes compact the default:

export const resolveMcpInputSchemaProfile = (profile) => profile ?? "compact";

Measured with the shipped CLI on a disposable home: tools/list is 3678.8 KB with the profile unset and 4260.2 KB with REA_MCP_INPUT_SCHEMA_PROFILE=full. So the default already sends the smaller advertisement, and the 496 KB figure belongs to the full profile.

Refs #5861 — the behaviour side of that report landed as #5975; this is the documentation follow-up.

Change and scope

Two edits in one paragraph: the measurement now names the full profile, and the remediation says compact is the default and only a pinned full needs changing. Nothing else changes.

Contract and boundary impact

Documentation only. No CLI, MCP/tool-catalog, provider, artifact, or generated-metadata change; docs:check passes unchanged.

Documentation or usability only; no target interaction.

Evidence and regression coverage

The two payload sizes above come from the shipped CLI with a disposable home. No tests added — this changes prose only, and the profile resolver and its tests already own the default.

Validation performed

node scripts/rea.mjs mcp with and without REA_MCP_INPUT_SCHEMA_PROFILE=full — payload sizes tabulated above
npx oxfmt --check docs/client-configuration.md — exit 0
npm run docs:check — exit 0, 9 tests passed

Compatibility, safety, and release

No breaking change, migration step, package or release metadata impact, or security review. Documentation only.

Author readiness

Human owner: @XiaoBinGan

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 or an agreed enhancement.
Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
The PR has one focused outcome and the title follows type(scope): outcome.
Related issue is linked, or the reason for not linking one is stated above.
Owning docs, contracts, and generated metadata are updated where needed.
I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

_{🔄 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/7202 **Author:** [@XiaoBinGan](https://github.com/XiaoBinGan) **Created:** 10/26/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/mcp-input-schema-default` --- ### 📝 Commits (1) - [`10d1218`](https://github.com/morluto/rea/commit/10d1218d8dcad76a8681ca162cfea3ef0c898565) docs(mcp): describe compact input advertisements as the default ### 📊 Changes **1 file changed** (+8 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `docs/client-configuration.md` (+8 -7) </details> ### 📄 Description ## Summary The Claude Code section tells readers to add `"REA_MCP_INPUT_SCHEMA_PROFILE": "compact"` because compact is not the default. Compact became the default in #5975 (`perf(mcp)!: default to compact input schema advertisements`, merged 2026-10-21). ## Problem and expected behavior `docs/client-configuration.md` says the measured payload is the "default profile", then tells readers to add the compact override to shrink it: > with 172 tools, that payload measured about 496 KB with the default profile and about 290 KB with `compact`. > To shrink the upfront catalog, add `"REA_MCP_INPUT_SCHEMA_PROFILE": "compact"` to the `env` object of the `mcpServers.rea` entry ... then restart Claude Code. The resolver makes compact the default: ```ts export const resolveMcpInputSchemaProfile = (profile) => profile ?? "compact"; ``` Measured with the shipped CLI on a disposable home: `tools/list` is 3678.8 KB with the profile unset and 4260.2 KB with `REA_MCP_INPUT_SCHEMA_PROFILE=full`. So the default already sends the smaller advertisement, and the 496 KB figure belongs to the `full` profile. Refs #5861 — the behaviour side of that report landed as #5975; this is the documentation follow-up. ## Change and scope Two edits in one paragraph: the measurement now names the `full` profile, and the remediation says compact is the default and only a pinned `full` needs changing. Nothing else changes. ## Contract and boundary impact Documentation only. No CLI, MCP/tool-catalog, provider, artifact, or generated-metadata change; `docs:check` passes unchanged. - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage The two payload sizes above come from the shipped CLI with a disposable home. No tests added — this changes prose only, and the profile resolver and its tests already own the default. ## Validation performed - `node scripts/rea.mjs mcp` with and without `REA_MCP_INPUT_SCHEMA_PROFILE=full` — payload sizes tabulated above - `npx oxfmt --check docs/client-configuration.md` — exit 0 - `npm run docs:check` — exit 0, 9 tests passed ## Compatibility, safety, and release No breaking change, migration step, package or release metadata impact, or security review. Documentation only. ## Author readiness Human owner: @XiaoBinGan - [x] 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. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-11-03 13:39:49 +00:00

closed this issue
added the
pull-request
label

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#7712

No description provided.

Rows
Columns