docs: document discovery & health-check intervals (#608) - #623
Merged
Conversation
The docs.mcpproxy.app config-file/upstream-servers pages (Docusaurus, sourced from docs/configuration/) were missing the configurable health_check_interval / tool_discovery_interval settings shipped in #609. - config-file.md: add a "Tool Discovery & Health Check Intervals" section (global defaults, ranges, 0s=disabled, Docker no-op, hot reload) and the keys to the reference JSON. - upstream-servers.md: add the per-server override fields with a link to the global reference. Closes the docs follow-up requested in #608. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 task
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the configurable
health_check_interval/tool_discovery_intervalsettings (shipped in #609) on the docs.mcpproxy.app site, addressing the follow-up requested by @albertovelo in #608.The site is built by Docusaurus from
docs/configuration/, and those pages had not been updated when the feature landed (the comprehensivedocs/configuration.mdguide already covered it).Changes
docs/configuration/config-file.md— new "Tool Discovery & Health Check Intervals" section: global defaults (30s/5m), accepted ranges (0sor5s–1h/30s–24h),0s= disabled, per-server resolution order, Dockerhealth_check_intervalno-op, hot reload, and the Settings → Advanced UI location. Keys also added to the reference JSON.docs/configuration/upstream-servers.md— per-server override fields added to the Configuration Options table with a link to the global reference.Verification
/configuration/config-file/and/configuration/upstream-servers/(baseUrl/).#tool-discovery--health-check-intervalsmatches the Docusaurus slug for the new heading.Closes the docs request in #608.
🤖 Generated with Claude Code