Skip to documentation

MCP tool reference and form workflow

Use exact tool names to inspect feedback, create forms, publish drafts and read responses.

Updated Read as Markdown

Read tools

Tool Main inputs Result
search_docs query, optional limit Public documentation matches with links and excerpts
list_brands No required input Accessible brands and IDs
list_inboxes Optional brandId Accessible inbox IDs and collection keys
get_feedback Filters such as brandId, inboxId, type, startDate, endDate; pagination Inbox feedback events
get_feedback_stats Brand/inbox and period filters Aggregate feedback statistics
search_feedback query, optional brand/inbox and limit Keyword matches in feedback comments/context
list_feedback_pages Optional brandId, status, limit, offset Visible forms; limited-scope listing may be published-only
get_feedback_page pageId Form settings and ordered questions
get_feedback_page_responses pageId, optional limit, cursor Submitted answers with question labels
list_feedback_page_shares pageId People a private form is shared with

Form tools accept optional organizationId; it must match the credential's organization. Use the connection's credential rather than asking the assistant to repeat a key in each prompt.

search_docs searches this public documentation. search_feedback searches customer feedback and requires data access. Neither tool is an alias for the REST semantic feedback search.

Create, inspect and publish

Ask the assistant to discover a brand first. Then use a small, reviewable draft:

json
{
  "brandId": "BRAND_ID",
  "title": "API onboarding feedback",
  "status": "draft",
  "questions": [
    { "type": "stars", "prompt": "How easy was setup?", "required": true },
    { "type": "text", "prompt": "What could we improve?" }
  ]
}

These are arguments to create_feedback_page. It returns the new ID, slug, short code and short URL. Draft is the default when status is omitted. The creation call accepts up to 50 questions; this is a per-call tool limit.

Call get_feedback_page with the new ID and inspect wording, options, required fields and visibility. To publish, call update_feedback_page:

json
{ "pageId": "PAGE_ID", "status": "published" }

To close the form, set status to archived. The tool exposes no form deletion operation. Publishing, sharing and changing a live form affect other people; tell the assistant what you want changed and review its proposed action.

Read responses and edit carefully

get_feedback_page_responses defaults to 50 responses, with a maximum of 100. Pass the returned cursor to read another page rather than assuming one response contains the full survey history.

replace_feedback_page_questions replaces up to 50 questions in order. Existing questions are matched by case-insensitive prompt text first. Remaining incoming questions reuse remaining old question IDs in order, retaining their answers. Leftover old questions may be deleted with their answers, subject to permissions.

That means replacing questions A/B with A/C can make C inherit B's answers. Use replacement for careful wording edits; create or clone a form for a different survey.

Write tools

  • submit_feedback: record an inbox event; provide inboxKey, type, and a score for thumbs/stars/CSAT/NPS. Optional comment is limited to 2,000 characters.
  • create_feedback_page: create a draft or published form.
  • update_feedback_page: change settings, publish or archive.
  • replace_feedback_page_questions: replace the complete ordered question set.
  • share_feedback_page / unshare_feedback_page: creator-managed private sharing using a member's email.

See permissions before choosing a key. A tool being listed does not mean the active credential may execute it.