zmuxuny opened a new issue, #7119:
URL: https://github.com/apache/rocketmq-dashboard/issues/7119

   ### Before Creating the Doc Report
   
   - [x] I have searched the [open 
issues](https://github.com/apache/rocketmq-dashboard/issues) and found no 
similar issue.
   
   
   ### Which Documentation
   
   README.md / README_zh.md AI Assistant section and the rmqctl/ module on 
rocketmq-studio @ 127c47b06a268cc74224d5f34c56ec7c36ac0d55.
   
   ### What Is Wrong
   
   The README advertises standalone rmqctl topic list and mcp config, but its 
rmqctl link opens a module directory with no README. A new CLI user is not 
shown how to build the binary, configure an access context, select it, or 
supply the required Studio instance name. The browser login/password is not the 
HMAC credential pair, and --instance-id is deliberately not defaulted from a 
context. Following the advertised topic list command alone therefore stops 
before a request. The context file path and environment-variable references are 
also currently discoverable only through implementation/help.
   
   ### Suggested Change
   
   Add concise English and Chinese module READMEs, linked from the root 
READMEs. Cover a source build, offline discovery/help, config 
set-context/use-context/get-contexts with environment-variable references, the 
registered Studio instance name and a read-only topic-list example, default 
config-path precedence, and an MCP snippet with an absolute executable path and 
explicit target. Document that the MCP host must inherit credentials and --yes 
does not bypass server policy. Verify examples against the built CLI in a 
temporary HOME/config; do not claim a live cluster test. No behavior or 
dependency changes. All-state duplicate searches: standalone CLI docs, rmqctl 
quick start, set-context documentation; #5144 concerns completion, #5007 the 
release/root deployment quick start, #5916 validates snippet inputs, and #6960 
proposes installer trust rather than usage.
   
   ### Are You Willing to Submit a Pull Request?
   
   - [x] Yes, I am willing to submit a pull request.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to