docs(installation): pin manual MCP registration to the release version (#658)

This commit is contained in:
Kaoru0822 authored and GitHub committed 2026-10-06 13:50:08 +08:00
1 parent 5802ef8746
commit 8dd1d84471
4 files changed
+18 -8

No files matched your search

+9 -4
View File
@@ -323,17 +323,22 @@ server through `npx` with the `mcp` command.
For a client that requires manual configuration, use:
<!-- x-release-please-start-version -->
```json
{
"mcpServers": {
"rea": {
"command": "npx",
"args": ["-y", "rea-agents@latest", "mcp"]
"args": ["-y", "rea-agents@4.0.1", "mcp"]
}
}
}
```
Use an exact `rea-agents@VERSION` in the arguments when a reproducible client
configuration is required. `rea setup` writes the same package-runner shape and
pins it to the exact version that performed setup.
<!-- x-release-please-end -->
Persistent registrations should use one exact package version. `rea setup`
writes the same package-runner shape and pins it to the exact version that
performed setup. Run current setup to refresh an older registration, then
restart the client.
+1
View File
@@ -21,6 +21,7 @@
{ "type": "generic", "path": "README_ja.md" },
{ "type": "generic", "path": "README_ko.md" },
{ "type": "generic", "path": "README_ar.md" },
{ "type": "generic", "path": "docs/installation.md" },
{
"type": "generic",
"path": "src/generatedPackageMetadata.ts"
+1 -1
View File
@@ -95,7 +95,7 @@ describe("localized README product facts", () => {
mcpServers: expect.objectContaining({
rea: expect.objectContaining({
command: "npx",
args: ["-y", "rea-agents@latest", "mcp"],
args: ["-y", PRODUCT_IDENTITY.registrationPackageSpecifier, "mcp"],
}),
}),
}),
@@ -7,12 +7,13 @@ import { SUPPORTED_NODE_VERSION_RANGE } from "../../src/domain/runtimeVersion.js
const readJson = async (path: string): Promise<unknown> =>
JSON.parse(await readFile(path, "utf8")) as unknown;
const readmes = [
const versionedDocumentation = [
"README.md",
"README_zh.md",
"README_ja.md",
"README_ko.md",
"README_ar.md",
"docs/installation.md",
] as const;
describe("release configuration", () => {
@@ -29,7 +30,10 @@ describe("release configuration", () => {
packages: {
".": {
"extra-files": [
...readmes.map((path) => ({ type: "generic", path })),
...versionedDocumentation.map((path) => ({
type: "generic",
path,
})),
{
type: "generic",
path: "src/generatedPackageMetadata.ts",
@@ -55,7 +59,7 @@ describe("release configuration", () => {
});
});
it.each(readmes)(
it.each(versionedDocumentation)(
"marks the versioned package example in %s",
async (path) => {
const content = await readFile(path, "utf8");