zmuxuny opened a new pull request, #7120:
URL: https://github.com/apache/rocketmq-dashboard/pull/7120

   ### Which Issue(s) This PR Fixes
   
   Fixes #7119
   
   ### Brief Description
   
   The root READMEs advertise standalone `rmqctl topic list` and `mcp config`, 
but their module link currently opens a directory with no usage guide. Add 
English/Chinese module READMEs and matching root links covering:
   
   - a native source build and offline command discovery;
   - context creation/selection using environment-variable **names**, with 
config-file precedence;
   - the distinction between browser login and the instance's signed-request 
credential, and the registered Studio instance **name** required on each tool 
call;
   - a read-only topic-list example and MCP configuration with an absolute 
executable path;
   - credentials inherited by the MCP host, supported endpoint schemes, and 
confirmation-policy boundaries.
   
   Commands are rooted in one working directory. No production code, 
dependencies, settings, credentials, or behavior changes. This does not add an 
installer or change the existing completion/snippet implementations.
   
   ### How Did You Test This Change?
   
   On Linux with Go 1.27.1, from the repository root:
   
   ```sh
   unset GOOS GOARCH
   make -C rmqctl build
   ./rmqctl/bin/rmqctl version
   ./rmqctl/bin/rmqctl --help
   ./rmqctl/bin/rmqctl explain topic
   ./rmqctl/bin/rmqctl topic list --help
   ```
   
   Build/catalog verification and both native license-generation checks passed 
(11 actual components, 26 files). All four offline commands work with an empty 
temporary HOME and no config.
   
   Executed the documented context commands in an isolated temporary HOME using 
fixture-only environment values. Verified that the resulting 
`~/.rmqctl/config.yaml` contains environment references, not resolved 
credentials or an instance default; verified `--config > RMQCTL_CONFIG > 
default` precedence.
   
   The documented read-only topic-list invocation was checked against a 
**loopback HTTP fixture**, not a live Studio or RocketMQ cluster. The fixture 
asserted `/api/mcp/tools/call`, `rmq.topic.list`, the explicit `instanceId`, 
and the HMAC-signed request; the command returned its JSON payload. Missing 
`--instance-id` fails before the fixture receives a request. Generated MCP 
snippets contain the absolute executable, selected context, explicit instance, 
and custom config path when supplied, and make no network request.
   
   Also checked all four EN/ZH shell blocks for exact command parity and `sh 
-n` syntax, relative file links/anchors, and `git diff --check`. Independent 
review compared the guide with the current Go/Java credential resolution and 
command implementations. No backend/frontend suite was run for Markdown-only 
changes.
   
   ### Checklist
   
   - [x] One coherent documentation change
   - [x] English and Chinese instructions kept in sync
   - [x] Commands verified with the built CLI
   - [x] Independent review completed
   - [x] No source files added, no new license-header requirement
   
   AI assistance was used to inspect the implementation, write/review the 
guide, and execute its verification.
   


-- 
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