Skip to content

docs: require user-facing changeset wording, rewrite the v1-mcp entry - #3020

Open
bj456736 wants to merge 2 commits into
MoonshotAI:mainfrom
bj456736:changeset-wording-user-facing
Open

docs: require user-facing changeset wording, rewrite the v1-mcp entry#3020
bj456736 wants to merge 2 commits into
MoonshotAI:mainfrom
bj456736:changeset-wording-user-facing

Conversation

@bj456736

Copy link
Copy Markdown
Contributor

Motivation

Recently merged changesets show two recurring wording problems:

  • .changeset/v1-mcp-management-plane.md shipped an SDK paragraph that reads like an API reference — a ten-line enumeration of method names (listMcpServers, getMcpServer, testMcpServerConfig, addMcpServer, reconnectMcpServer, listMcpServerAuthStatuses, inspectAppMcpServers, …). The current skill explicitly allows this ("write those entries honestly and technically; their wording does not need to suit end users"), so the skill is the right place to fix it.
  • New feature entries give no maturity/availability signal — e.g. the /tower entry does not say whether the feature is experimental, gated, or generally available, so readers cannot tell what they can actually use.

Changes

.agents/skills/gen-changesets/SKILL.md

  • Reword the SDK/internal-package license: nobody curates those changelogs later, so entries must still be short and readable — summarize the capability change (what callers can now do, what behavior changed) in one or two sentences; never enumerate methods/parameters/fields like an API reference.
  • New wording rule: write for a reader who does not know the codebase; one outcome per entry; no semicolon/slash-list sentence stuffing — split into separate changesets instead.
  • New wording rule: say who can actually use the change — experimental, flag-gated, engine-gated (legacy / v2), platform- or surface-specific (TUI / kimi web / VSCode) must be stated in plain words.
  • New workflow step: re-read the finished entry from a user's perspective before committing; for user-facing changes the human author should proofread the entry before merge.
  • Matching red flags for all of the above.

.changeset/v1-mcp-management-plane.md

Rewrite the entry per the new rules. Frontmatter unchanged. The CLI paragraph keeps its three effects but is split into two readable sentences; the SDK paragraph becomes a capability-level summary with zero method-name enumeration.

Before (SDK paragraph, abridged): "the MCP management surface is now backed by a unified, source-tagged registry — listMcpServers also covers plugin-declared servers … new getMcpServertestMcpServerConfigaddMcpServerreconnectMcpServerlistMcpServerAuthStatusesinspectAppMcpServersauthenticateAppMcpServer / resetAppMcpServerAuth …" (~10 lines)

After: "MCP servers are now managed through a unified registry that also covers plugin-declared servers. SDK callers can list, inspect, probe, add, reconnect, and authenticate MCP servers at runtime — including plugin servers — with effective config and probe-verified authorization state. Stored OAuth grants now record expiry and refresh proactively, concurrent logins for the same credential share one browser flow, and secret-bearing env / headers values are redacted to key lists in status responses."

No code changes; no changeset needed for this PR itself.

@changeset-bot

changeset-bot Bot commented Aug 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 1f3a176

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes changesets to release 4 packages
Name Type
@moonshot-ai/kimi-code Patch
@moonshot-ai/kimi-code-sdk Minor
kimi-code Patch
@moonshot-ai/acp-adapter Patch

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new

pkg-pr-new Bot commented Aug 18, 2026

Copy link
Copy Markdown
pnpm dlx https://pkg.pr.new/@moonshot-ai/kimi-code@1f3a176
npx https://pkg.pr.new/@moonshot-ai/kimi-code@1f3a176

commit: 1f3a176

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1f3a176741

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

---

On the legacy engine, plugin MCP server changes (install / enable / disable / remove / reload) now apply to open sessions immediately, and an MCP server OAuth sign-in or credential reset automatically refreshes the affected sessions instead of leaving them stuck until a manual reconnect; a connection that fails mid-session for auth reasons is now reported as needing sign-in rather than as a generic failure.
On the legacy engine, MCP server changes (install / enable / disable / remove / reload) now apply to open sessions immediately — no manual reconnect needed. Signing in to an MCP server with OAuth or resetting its credential now automatically refreshes the affected sessions, and a connection that fails mid-session for auth reasons is reported as needing sign-in instead of a generic failure.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Restore the plugin scope in the legacy-engine summary

The listed install, enable/disable, remove, and reload actions are plugin-management operations: the corresponding KimiCore plugin mutators are what call syncPluginMcpServersInSessions. Removing “plugin” from the previous wording makes this read as though MCP servers themselves expose all five operations and obscures which user workflow gained live-session synchronization; retain the plugin qualifier or explicitly describe plugin-provided MCP servers.

Useful? React with 👍 / 👎.

On the legacy engine, MCP server changes (install / enable / disable / remove / reload) now apply to open sessions immediately — no manual reconnect needed. Signing in to an MCP server with OAuth or resetting its credential now automatically refreshes the affected sessions, and a connection that fails mid-session for auth reasons is reported as needing sign-in instead of a generic failure.

`@moonshot-ai/kimi-code-sdk`: the MCP management surface is now backed by a unified, source-tagged registry — `listMcpServers` also covers plugin-declared servers (read-only, with their effective config) and returns `source` / `origin` / `mutable` markers; new `getMcpServer` for a single effective config; `testMcpServerConfig` probes an unsaved inline config; sessions can connect a server at runtime via `addMcpServer` with an optional persist flag; `reconnectMcpServer` accepts an optional replacement config and otherwise re-resolves the current config instead of reusing a stale snapshot; `listMcpServerAuthStatuses` accepts `cwd` / `verify` (online probe) and distinguishes dead grants via the new `oauth-expired` state; stored OAuth grants now record their absolute expiry and are refreshed proactively and single-flight per credential. Session status entries and read-only management entries redact secret-bearing stdio `env` / remote `headers` values to key lists, and concurrent logins for the same credential join a single browser flow. A new app-level inspection, `inspectAppMcpServers`, reports every server's effective config and real (probe-verified) authorization state — including plugin servers and runtime-name collisions — and the OAuth flow RPCs have locator-addressed variants (`authenticateAppMcpServer` / `resetAppMcpServerAuth`) so plugin servers can be signed in and reset directly.
`@moonshot-ai/kimi-code-sdk`: MCP servers are now managed through a unified registry that also covers plugin-declared servers. SDK callers can list, inspect, probe, add, reconnect, and authenticate MCP servers at runtime — including plugin servers — with effective config and probe-verified authorization state. Stored OAuth grants now record expiry and refresh proactively, concurrent logins for the same credential share one browser flow, and secret-bearing `env` / `headers` values are redacted to key lists in status responses.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Apply the new concise-entry rule to the rewritten changeset

This paragraph still combines the registry change, six runtime-management capabilities, OAuth expiry/refresh behavior, login deduplication, and secret redaction into three dense sentences. Because this raw text is copied directly into the SDK changelog, it remains exactly the multi-outcome technical paragraph that the newly added “one outcome per entry” and concise-wording guidance is intended to prevent; split the independent outcomes or retain only the primary caller-facing capability.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant