You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by "zmuxuny (via GitHub)" <gi...@apache.org> on 2026/10/19 15:12:55 UTC

[PR] docs(rmqctl): add a standalone setup and MCP guide [rocketmq-dashboard]

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: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(rmqctl): add a standalone setup and MCP guide [rocketmq-dashboard]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #7120: docs(rmqctl): add a standalone setup and MCP guide
URL: https://github.com/apache/rocketmq-dashboard/pull/7120


-- 
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: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(rmqctl): add a standalone setup and MCP guide [rocketmq-dashboard]

Posted by "zmuxuny (via GitHub)" <gi...@apache.org>.
zmuxuny commented on PR #7120:
URL: https://github.com/apache/rocketmq-dashboard/pull/7120#issuecomment-6273166913

   CI triage for [run 39275979348](https://github.com/apache/rocketmq-dashboard/actions/runs/39275979348): rmqctl, backend build/tests and frontend Docker build all passed. The frontend job passed 1,830 tests; the sole failure is `ConsumerPage.test.tsx:1456`, `highlights inconsistent subscriptions and refreshes the check result`.
   
   This PR changes only four Markdown files. The failure matches the pre-existing polling/mock-sequence issue tracked by #5626; the controlled baseline reproduction is documented in https://github.com/apache/rocketmq-dashboard/pull/7090#issuecomment-6272236006. The remote DOM dump alone does not establish the exact timer ordering. I have kept the documentation change scoped and have not copied the unrelated test fix.


-- 
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: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] docs(rmqctl): add a standalone setup and MCP guide [rocketmq-dashboard]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #7120:
URL: https://github.com/apache/rocketmq-dashboard/pull/7120#issuecomment-6484195276

   This pull request has been automatically closed because there has been no activity for 7 days. If you would like to continue working on this, please reopen the PR with updated changes.


-- 
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: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org