Skip to content

docs: document async loading sub-parameters - #398

Draft
adity982 wants to merge 1 commit into
1mcp-app:mainfrom
adity982:agent/document-async-loading-options
Draft

docs: document async loading sub-parameters#398
adity982 wants to merge 1 commit into
1mcp-app:mainfrom
adity982:agent/document-async-loading-options

Conversation

@adity982

Copy link
Copy Markdown

Summary

  • document every async-loading CLI sub-parameter with its runtime default and behavior
  • explain readiness, timeout, batching, and notification tradeoffs for small and large server fleets
  • add matching guidance and an example to both the English and Chinese fast-startup guides

Validation

  • targeted Prettier check for both guides
  • pnpm docs:build

Closes #393

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a5faf02f-7720-4371-ae64-0bfaa5568351

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@xizhibei

Copy link
Copy Markdown
Contributor

Thank you for your contribution. I noticed this is still marked as a draft — would you like any further revisions, or is it ready to be merged?

@xizhibei

Copy link
Copy Markdown
Contributor

This was generated by AI during triage.

Thanks for drafting the bilingual documentation. Source tracing found that the current table describes behavior that is not implemented: --async-min-servers and --async-timeout do not gate request acceptance, /health/ready, or capability publication.

Please keep this PR in draft and revise it against the accepted contract in #393: #393 (comment)

Required changes before this can be ready:

  • Do not document or recommend server-count readiness thresholds.
  • Deprecate the two ineffective CLI flags, their environment forms, and the matching TOML keys as warning compatibility no-ops.
  • Add and document --async-notify-on-snapshot; retain --async-notify-on-ready as a deprecated alias for one compatibility window.
  • Describe publication as one changed capability snapshot after all backends reach a terminal state.
  • Describe batching as coalescing capability-change events within the configured delay.
  • Clarify that /health/ready is configuration readiness and /health/mcp reports backend loading progress.
  • Include the runtime changes and focused tests, or retarget this PR so it no longer claims to close Document async loading sub-parameters (--async-min-servers, --async-timeout, --async-batch-notifications) #393 and make it depend on the runtime implementation.

The English and Chinese documentation should remain aligned.

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.

Document async loading sub-parameters (--async-min-servers, --async-timeout, --async-batch-notifications)

2 participants