docs(model-tool): 补充 reply tool 字段与工具元数据说明#25
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 2 minutes and 9 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for tool registration, specifically adding details for the meta field and introducing a mechanism to register custom fields for the character_reply tool within the chatluna-character plugin. Feedback suggests improving the documentation's consistency by adding the description field to the parameter list, using string literals instead of undefined variables in examples, and including the Config interface in the example code to follow standard plugin patterns.
| - `session` - 当前会话对象 | ||
| - 返回：`Tool` 实例 | ||
| - 用途：创建并返回工具的实例 | ||
| - `meta`: 工具元数据（推荐填写） |
There was a problem hiding this comment.
在下方的示例代码（第 193 行）中使用了 description 字段，但在 registerTool 的参数说明列表中未包含该字段。建议在此处补充 description 的说明，以保持文档的一致性。
| - `meta`: 工具元数据（推荐填写） | |
| - `description`: 工具描述（可选） | |
| - `meta`: 工具元数据（推荐填写） |
|
|
||
| ```ts | ||
| plugin.registerTool('web_search', { | ||
| description: SEARCH_TOOL_DESCRIPTION, |
There was a problem hiding this comment.
建议使用字符串字面量代替未定义的变量 SEARCH_TOOL_DESCRIPTION，或者在代码块中提供其定义，这样可以使示例代码更加直观且易于理解。
| description: SEARCH_TOOL_DESCRIPTION, | |
| description: '网络搜索工具', |
| import { Context } from 'koishi' | ||
| import type {} from 'koishi-plugin-chatluna-character' | ||
|
|
||
| export function apply(ctx: Context) { |
There was a problem hiding this comment.
在 CharacterReplyToolField 接口定义中引用了 Config 类型，但在示例代码中未定义该接口。建议补充 Config 的定义并将其作为 apply 函数的参数，以符合 Koishi 插件的标准写法并保证代码片段的完整性。
| export function apply(ctx: Context) { | |
| export interface Config {} | |
| export function apply(ctx: Context, config: Config) { |
1 participant
Summary
registerTool的meta工具元数据说明，说明source、group、tags与defaultAvailability.characterScope的用途chatluna-character的registerReplyToolField()开发说明，说明如何为character_reply挂载与消息交互相关的自定义字段Verification