跳转到内容

Endpoints

此内容尚不支持你的语言。

Vibma exposes 18 endpoint tools instead of dozens of standalone tools. Each endpoint groups related operations behind a single tool with a method parameter — similar to a REST resource.

In addition to endpoint tools, Vibma also includes standalone help and guidelines tools. Use help to discover the API surface, and guidelines for design-system and structural best practices.

LLMs work better with fewer, well-documented tools than with a long flat list. Instead of create_frame, get_frame, list_frames, update_frame, delete_frame as five separate tools, a single frames endpoint handles all of them. This:

  • Reduces tool count — 18 endpoints cover 93 methods
  • Groups related operations — the AI sees all frame operations together in one description
  • Shares parametersfields, depth, offset, limit work the same everywhere
  • Enables capability gating — read methods are always available, create/edit methods appear based on --create / --edit flags

Every call requires a method parameter:

{ "method": "list" }
{ "method": "get", "id": "1:2", "depth": 0 }
{ "method": "create", "type": "frame", "items": [{"name": "Card", "width": 300, "height": 200}] }

Most endpoints support some subset of these:

MethodPurposeTier
listSearch / paginate resourcesread
getGet detail by IDread
createCreate new resourcescreate
updatePatch existing resourcesedit
deleteRemove resourcesedit

Some endpoints add domain-specific methods like clone, reparent, export, scan, swap, detach, add_mode, etc.

create, update, and delete return a results array — one entry per input item, in order. Each entry is either "ok", an object like {id: "..."}, or {error: "message"}. This allows partial success:

{
"results": [
{ "id": "5:2" },
{ "error": "Name already exists" }
]
}

Endpoints that operate on scene-graph nodes (frames, text) extend a shared node base that provides get, list, update, delete, clone, and reparent automatically. These inherited methods work identically across all node endpoints.

Some create methods use a type discriminant to select between different item shapes:

{ "method": "create", "type": "auto_layout", "items": [{"layoutMode": "VERTICAL", "itemSpacing": 8}] }
{ "method": "create", "type": "section", "items": [{"name": "Hero"}] }

Each type has its own parameter schema documented on the endpoint page.

Every endpoint also supports method: "help" for endpoint-local reference:

{ "method": "help" }
{ "method": "help", "topic": "create" }

Use the standalone help() tool when you need the global directory of endpoints or method-level help in endpoint.method form, such as help(topic: "frames.create").

Methods are gated by startup flags:

FlagAvailable methods
(none)get, list, check, scan, export
--createAbove + create, clone
--editAll methods

If create/edit methods are missing, see the missing_tools prompt.