Help

查看任意端点或方法的帮助信息。这个工具面向正在配置、调试或部署代理的用户，用来快速了解 Vibma 提供了哪些能力，以及某个端点或方法该怎么调用。

工作方式

// help() 返回所有可用端点与特殊主题的目录。
// help(topic: "components") 返回该端点的概览。
// help(topic: "components.create") 返回方法级说明。
// 大多数端点也支持 method:"help" 和 topic:"<method>" 的局部帮助。

适用场景

• 当你在为代理编写系统提示词、工作流提示词或工具使用说明时，用它确认正确的端点和方法名。
• 当某个模型一直调用错工具或传错参数时，用它快速查清 API 结构。
• 当你在接入更小或不太熟悉 Vibma 的模型时，可以把 help() 的输出作为额外上下文提供给它。

1 method available.

get

read

读取帮助目录、端点概览或方法参考

Parameter	Type	Required	Description
topic	string	✗	端点名或 endpoint.method，例如 "components" 或 "components.create"

Response

Field	Type	Description
result	string	纯文本帮助内容

示例

{}

{ "topic": "frames" }

{ "topic": "frames.create" }

help() 和 method: "help" 的区别

• 当你需要查看 Vibma 的全局端点目录、了解系统能做什么，或使用完整的 endpoint.method 格式时，使用 help()。
• 当你已经知道目标端点，只想查看这个端点内部某个方法的说明时，使用端点自己的 method: "help"，例如 frames(method: "help", topic: "create")。