-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
docs: init skills #5783
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
gxkl
wants to merge
2
commits into
next
Choose a base branch
from
docs/skills
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,503
−0
Draft
docs: init skills #5783
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # @eggjs/skills |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| name: egg-controller | ||
| description: Use when creating API endpoints, implementing protocol handlers, or exposing interfaces for specific clients. Covers HTTP, MCP and Schedule controllers for EGG framework applications. | ||
| allowed-tools: Read | ||
| --- | ||
|
|
||
| # EGG 控制器 | ||
|
|
||
| --- | ||
|
|
||
| ## 控制器选择决策树 | ||
|
|
||
| ``` | ||
| 需要暴露什么接口/客户端协议? | ||
|
|
||
| 1. HTTP 接口?例如 HTML/JSON/SSR/SSE,可以使用 HTTPController,参考 `references/http-controller.md` | ||
|
|
||
| 2. 定时任务,可以使用 Schedule,参考 `references/schedule.md` | ||
|
|
||
| 3. AI集成 MCP,可以使用 MCPController,参考 `references/mcp-controller.md` | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## 控制器快速参考 | ||
|
|
||
| ### HTTPController | ||
|
|
||
| - **装饰器**:`@HTTPController`、`@HTTPMethod` | ||
| - **参数**:`@HTTPParam`、`@HTTPQuery`、`@HTTPBody`、`@HTTPHeaders`、`@Cookies`、`@Request`、`@Context` | ||
| - **详细文档**:`references/httpcontroller.md` | ||
|
|
||
| ### MCPController | ||
|
|
||
| - **装饰器**:`@MCPController`、`@MCPTool`、`@MCPPrompt`、`@MCPResource` | ||
| - **特点**:集成 LLM、Zod 验证、登录态支持 | ||
|
|
||
| ### Schedule | ||
|
|
||
| - **装饰器**:`@Schedule<T>`、配置 | ||
| - **模式**:Worker/All | ||
|
|
||
| --- | ||
|
|
||
| ## 最佳实践 | ||
|
|
||
| - **控制器精简**:业务逻辑委托给 Service 层 | ||
| - **参数验证**:使用装饰器和类型定义 | ||
| - **错误处理**:根据协议转换错误和响应码 | ||
| - **RESTful 设计**:遵循 HTTP 方法和资源命名 | ||
| - **响应一致性**:统一响应格式 | ||
|
|
||
| --- | ||
|
|
||
| ## 参考资料 | ||
|
|
||
| 详细的控制器开发文档: | ||
|
|
||
| - `references/http-controller.md` - HTTP 接口完整指南 | ||
| - `references/mcp-controller.md` - MCP/LLM 集成 | ||
| - `references/schedule.md` - 定时任务 | ||
|
|
||
| 核心概念(@eggjs/skills-core):模块、依赖注入、对象生命周期 | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a typo in the file path.
httpcontroller.mdshould behttp-controller.mdto be consistent with other links in this file and the actual filename.