Help

Get help on any endpoint or method. This tool is for people configuring, debugging, or deploying agents with Vibma who need a quick way to inspect the available endpoints and method-level parameters.

How it works

// help() returns the directory of available endpoints and special topics.
// help(topic: "components") returns the endpoint overview.
// help(topic: "components.create") returns method-level details.
// Most endpoint tools also support method:"help" with topic:"<method>" for local help.

When to use it

• Use it while writing system prompts, workflow prompts, or tool instructions for an agent so you can confirm the correct endpoint and method names.
• Use it when a model keeps calling the wrong tool or passing the wrong parameters and you need to inspect the API shape quickly.
• Use it when onboarding smaller or less Vibma-aware models; you can feed help() output into the prompt as extra context.

1 method available.

get

read

Read the help directory, an endpoint summary, or a method reference

Parameter	Type	Required	Description
topic	string	✗	Endpoint or endpoint.method name, e.g. "components" or "components.create"

Response

Field	Type	Description
result	string	Plain-text help content

Examples

{}

{ "topic": "frames" }

{ "topic": "frames.create" }

When to use help() vs method: "help"

• Use help() when you need the global directory of endpoints, want to discover what Vibma can do, or need the full endpoint.method reference format.
• Use an endpoint’s method: "help" when you already know the endpoint and only need help for that tool, for example frames(method: "help", topic: "create").