Problem / 问题
PI-Desktop already supports the official MCP Registry and user-managed static Catalog JSON sources. The current Start here guide does not show the user workflow for adding a catalog source, inspecting a remote entry, supplying its required credential, and removing the source or installed server later. The implementation and ADR 0245 describe the network boundary, but users and catalog publishers still have to assemble the setup instructions from source and PR discussions.
Proposed change / 期望改动
Would a small English/Chinese user guide for the existing MCP market flow fit the documentation?
The proposed scope is:
- Explain the distinction between the built-in offline catalog, the official Registry, and a user-added Catalog JSON URL.
- Show how to add a public HTTPS catalog, inspect an entry's endpoint and credential requirements, and install it through the existing form. Explain that catalog data contains placeholders, while each user supplies their own key.
- Include a minimal static catalog example with the supported placeholder syntax, plus source removal, installed-server removal, and version-sensitive troubleshooting.
- Link the guide from Start here. Keep the instructions generic and document the current product behavior.
There is a concrete optional community example: PI-Desktop setup guide and Baizhi Catalog JSON. The Baizhi example is user-selected, uses the existing remote MCP capability, and requires the user's Baizhi API key; service usage may consume credits. An external example link can be omitted if the documentation should contain only a generic fixture.
This scope leaves the built-in/default server list and runtime behavior unchanged. Maintainer guidance is welcome on the appropriate documentation location and whether an external community example belongs there.
Alternatives / 其他方案
- Keep the community guide and catalog independently published, with users adding the source themselves. This already fits the user-managed-source model.
- Contribute only a generic guide and sample catalog to PI-Desktop, with no external vendor link.
- Rely on the official Registry for discovery. That remains useful, but it does not explain how users publish or add a custom catalog source.
Additional context / 补充信息
The multi-source market was requested in #278, implemented in #285 and hardened in #330. #646 and #706 concern generic registry-header compatibility and credential scope; they did not add a Baizhi built-in entry. This proposal concerns documentation of the existing workflow.
The published validation runner passes nine focused catalog/configuration checks against each of main b71fcf05a67dce5bb91c5fbd1f96f3a15fc8fe9a and v0.15.1 source 515620a4b7f6ce90df256e28d10d95957df16792. It exercises native parsing, placeholder resolution, the real catalog aggregator with simulated network responses, renderer source assertions, and separately built Rust hosts for configuration persistence. It makes no MCP connection or production call. This is not a completed Electron UI walkthrough, downloaded-release test, or live Baizhi acceptance test. The guide explicitly distinguishes main-only fixes from the released source.
Disclosure: this contribution is part of integration and promotion work for Baizhi Cloud Agent Toolkit. The linked material is independently maintained community documentation; it is not an official PI-Desktop endorsement or default integration.
Problem / 问题
PI-Desktop already supports the official MCP Registry and user-managed static Catalog JSON sources. The current Start here guide does not show the user workflow for adding a catalog source, inspecting a remote entry, supplying its required credential, and removing the source or installed server later. The implementation and ADR 0245 describe the network boundary, but users and catalog publishers still have to assemble the setup instructions from source and PR discussions.
Proposed change / 期望改动
Would a small English/Chinese user guide for the existing MCP market flow fit the documentation?
The proposed scope is:
There is a concrete optional community example: PI-Desktop setup guide and Baizhi Catalog JSON. The Baizhi example is user-selected, uses the existing remote MCP capability, and requires the user's Baizhi API key; service usage may consume credits. An external example link can be omitted if the documentation should contain only a generic fixture.
This scope leaves the built-in/default server list and runtime behavior unchanged. Maintainer guidance is welcome on the appropriate documentation location and whether an external community example belongs there.
Alternatives / 其他方案
Additional context / 补充信息
The multi-source market was requested in #278, implemented in #285 and hardened in #330. #646 and #706 concern generic registry-header compatibility and credential scope; they did not add a Baizhi built-in entry. This proposal concerns documentation of the existing workflow.
The published validation runner passes nine focused catalog/configuration checks against each of main
b71fcf05a67dce5bb91c5fbd1f96f3a15fc8fe9aand v0.15.1 source515620a4b7f6ce90df256e28d10d95957df16792. It exercises native parsing, placeholder resolution, the real catalog aggregator with simulated network responses, renderer source assertions, and separately built Rust hosts for configuration persistence. It makes no MCP connection or production call. This is not a completed Electron UI walkthrough, downloaded-release test, or live Baizhi acceptance test. The guide explicitly distinguishes main-only fixes from the released source.Disclosure: this contribution is part of integration and promotion work for Baizhi Cloud Agent Toolkit. The linked material is independently maintained community documentation; it is not an official PI-Desktop endorsement or default integration.