docs(skills): add message controller reference and skill writing guid…

[jerryliang64]

…elines

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

• 🔍 Trigger a full review

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @jerryliang64, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for the EGG framework by introducing comprehensive guidance for MessageController. It integrates this new controller type into the existing SKILL.md overview and provides a detailed, standalone reference, enabling developers to effectively implement message subscription functionalities using SofaMQ, SofaMQX, and MsgBroker.

Highlights

• Documentation Update: The core SKILL.md documentation has been updated to include MessageController as a new type of controller for EGG framework applications, expanding the scope of supported controller types.
• New Controller Reference: A dedicated section for MessageController has been added to SKILL.md, outlining its decorators, parameters, features, and providing a direct link to its detailed guide.
• Comprehensive Guide for MessageController: A new document, message-controller.md, has been introduced, offering an in-depth guide for developing with MessageController. This guide covers common errors, file conventions, usage examples for SofaMQ and MsgBroker, parameter explanations, and decorator references.

Changelog

• packages/skills/controller/SKILL.md
  • Updated the description field to explicitly mention "Message controllers" alongside HTTP, MCP, and Schedule controllers.
  • Added a new numbered item (4) under the "控制器类型" (Controller Types) section, introducing MessageController for message subscription (sofamq/sofamqx/msgbroker) with a reference to references/message-controller.md.
  • Inserted a new "MessageController" subsection, detailing its decorators (@MessageController, @MessageMethod), parameters (MessageRequest), features (supports sofamq/sofamqx/msgbroker), and a link to its detailed documentation.
  • Appended references/message-controller.md to the list of related documentation links.
• packages/skills/controller/references/message-controller.md
  • This new file provides a complete guide for MessageController development.
  • It covers common errors (e.g., decorator source, single @MessageMethod, msgbroker eventCode requirement).
  • Outlines file location and naming conventions for MessageController within a module.
  • Presents a "Scenario Decision Tree" to guide users on choosing the correct MessageController configuration based on message type (sofamq/sofamqx, msgbroker) and metadata needs.
  • Includes end-to-end examples for SofaMQ and MsgBroker message subscriptions, as well as an example for obtaining message metadata.
  • Details common parameters (type, topic, group, eventCode, tags), function application-specific parameters (timeout, tps), and standard application-specific parameters (ldcSubmode, endpoint, concurrent).
  • Provides a reference table for key decorators (@MessageController, @MessageMethod, @Inject).
  • Includes important notes regarding @MessageController limitations (single @MessageMethod), msgbroker support in standard applications, and metadata access in function applications.

Activity

• No human activity has been recorded on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds comprehensive documentation for the MessageController, including usage guides, examples, and parameter specifications. The documentation is well-structured and detailed. I've pointed out a minor inconsistency in a parameter's type definition to improve accuracy. Overall, this is a high-quality documentation contribution.

[gemini-code-assist]

The type for the concurrent parameter is documented as string, but its default value is 20, which is a number. This is inconsistent and could be confusing. For clarity, please update the type to number.

Suggested change

	| `concurrent` | `string` | 并发数，默认 20（注意：以 group 维度生效） |
	| `concurrent` | `number` | 并发数，默认 20（注意：以 group 维度生效） |