Skip to main content

Tools

All tools operate on the platform of the admin who owns the key. Tools marked write require a read_write key; with a read key they return an error result and change nothing.

Write tools also update the platform's Firestore mirror (what the mobile apps read) exactly like dashboard writes do. Their response carries mobileMirror: synced, skipped (platform without a Firebase project) or failed (logged server-side; the MySQL write stands).

Results are returned as JSON text in the tool result. Errors (not found, wrong scope, guard rails) come back as a tool result with isError: true and a human-readable message.

Enum values used below:

  • content type: video embed, wistia, searchie, resi, download, restream, poll, video, audio, article, live streaming, link, zoom, internallink, mux, book, meeting
  • content visibility: public, free, basic, premium, group, hidden
  • group visibility: public, private, hidden

Content​

ToolScopeParametersNotes
list_contentreadlimit (1-100, default 25), offset (default 0), type, visibility, published_only (default false)Paginated summaries ordered by most recently updated. Returns { total, offset, limit, items }.
get_contentreadidFull detail for one item, including description, media URIs and moderation/transcoding status.
search_contentreadquery, limit (default 20)Case-insensitive substring match on title or description.
create_contentwritetitle, type, visibility (default public), description, slug, featuredImage, contentURI, video, duration, chatEnabled, collectionIds, publishedDateCreates a row owned by the key owner. Omit publishedDate to leave it unpublished. chatEnabled turns on comments. collectionIds must belong to the platform. featuredImage takes a storage path from get_image_upload_url or a full URL. Video upload and transcoding still happen through the dashboard.
update_contentwriteid, plus any of title, description, slug, visibility, featuredImage, contentURI, video, duration, ctaBtnText, ctaBtnUrl, featured, chatEnabled, collectionIdsOnly provided fields change. collectionIds replaces the full set ([] removes all). Content cannot be moved between platforms.
publish_contentwriteid, publishedAt (ISO, optional)Sets publishedDate to the given time or now.
list_collectionsreadsearch, limit (default 50), offsetCollections on the platform ordered by name. Returns { total, offset, limit, items: [{ id, name, slug }] }.
get_image_upload_urlwritefileName (png, jpg, jpeg, webp, gif)Returns { uploadUrl, path, contentType, expiresInSeconds }. PUT the file to uploadUrl with the Content-Type header, then pass path as featuredImage. The URL expires after one hour.
delete_contentwriteidPermanent. Removes the row, its Storj files and the Firestore mirror, the same cleanup as the dashboard delete.

Groups​

ToolScopeParametersNotes
list_groupsreadlimit (default 25), offset, visibilityGroup summaries.
get_groupreadidFull group detail (description, cover, headline, AI settings).
list_group_membersreadgroup_id, limit (default 50), offset, role (member or admin)Members with their membership role and basic user info.
list_group_postsreadgroup_id, limit (default 25), offsetPosts on the group's wall (content attached with ContentGroup.type = "post"), newest first. Scheduled posts are included with scheduled: true; comments are not posts and are not returned.
create_groupwritename, slug, description, visibility (default public), coverImg, headlineTextThe key owner is recorded as the group creator.
update_groupwriteid, plus any of name, description, visibility, coverImg, headlineText, headlineBtnText, headlineBtnUrlOnly provided fields change.
add_group_memberwritegroup_id, user_id, role (member default, or admin)The user must already exist on the platform. Updates the role if the membership exists. Returns { action, groupId, userId, role, mobileMirror }.

Users​

ToolScopeParametersNotes
list_usersreadlimit (default 50), offset, role, status (active or pending)Returns only public fields: id, name, email, role, status, city, state, photo, banned, team flag, timestamps. Never passwords, keys or additionalInfo.
search_usersreadquery, limit (default 25)Matches name or email.
get_userreadidOne user, same public fields.
update_user_rolewriteid, role (free, basic, premium, creator)Cannot set admin, cannot change an existing admin and cannot change the key owner.

Reports​

All report tools are read-only.

ToolParametersNotes
get_engagement_reportstart, end (ISO, default last 30 days)Platform totals: users, content, groups and analytics events in the window (analyticsEvents, plus analyticsBreakdown.contentEvents / userEvents).
get_group_engagement_reportgroup_idMember counts by role and content attached to the group.
get_content_statsid, start, endType, visibility, publish state and analytics events for one item.