UserHero Docs
MCP Server

MCP Tools Reference

Complete list of available MCP tools and their parameters

MCP Tools Reference

The UserHero MCP server provides tools organized by resource type. All tools respect your workspace role permissions.

Workspaces

list_workspaces

List all workspaces you have access to.

Parameters: None

Returns: Array of workspaces with id, name, plan, and your role

Example prompt:

"Show me all my UserHero workspaces"


get_workspace

Get detailed information about a specific workspace.

Parameters:

NameTypeRequiredDescription
workspaceIdstringYesThe workspace ID

Returns: Workspace details including members, plan, and settings


get_workspace_usage

Get usage statistics and plan limits for a workspace.

Parameters:

NameTypeRequiredDescription
workspaceIdstringYesThe workspace ID

Returns: Current usage, limits, and billing period info

Example prompt:

"How much of our feedback quota have we used this month?"

Projects

list_projects

List all projects in a workspace.

Parameters:

NameTypeRequiredDescription
workspaceIdstringYesThe workspace ID

get_project

Get project details including privacy settings.

Parameters:

NameTypeRequiredDescription
projectIdstringYesThe project ID

create_project

Create a new project. Requires member role or higher.

Parameters:

NameTypeRequiredDescription
workspaceIdstringYesThe workspace ID
namestringYesProject name
typestringYesweb, ios, or android
domainstringNoDomain for web projects

Example prompt:

"Create a new web project called 'Marketing Site' for domain marketing.example.com"


update_project

Update project settings. Requires member role or higher.

Parameters:

NameTypeRequiredDescription
projectIdstringYesThe project ID
namestringNoNew project name
domainstringNoNew domain
privacySettingsobjectNoPrivacy configuration

delete_project

Delete a project and all its data. Requires admin role or higher.

Parameters:

NameTypeRequiredDescription
projectIdstringYesThe project ID

This permanently deletes all widgets, feedback, and integrations for the project.

Widgets

list_widgets

List all widgets in a project.

Parameters:

NameTypeRequiredDescription
projectIdstringYesThe project ID

get_widget

Get widget configuration details.

Parameters:

NameTypeRequiredDescription
widgetIdstringYesThe widget ID

create_widget

Create a new feedback widget. Requires member role or higher.

Parameters:

NameTypeRequiredDescription
projectIdstringYesThe project ID
namestringYesWidget name
templatestringYesTemplate type (see below)
typestringNofloating, embedded, popup, link

Available templates:

  • feedback - General feedback form
  • bug-report - Bug report with screenshot
  • rating - Star rating
  • nps - Net Promoter Score (0-10)
  • satisfaction - Customer satisfaction
  • feature-request - Feature requests
  • contact - Contact form

Example prompt:

"Create a floating NPS widget called 'Monthly Survey'"


update_widget

Update widget configuration. Requires member role or higher.

Parameters:

NameTypeRequiredDescription
widgetIdstringYesThe widget ID
namestringNoNew widget name
configobjectNoWidget configuration
stylingobjectNoWidget styling
targetingobjectNoDisplay targeting rules

delete_widget

Delete a widget. Requires admin role or higher.

Parameters:

NameTypeRequiredDescription
widgetIdstringYesThe widget ID

Feedback

list_feedback

List feedback with optional filters.

Parameters:

NameTypeRequiredDescription
projectIdstringYesThe project ID
widgetIdstringNoFilter by widget
statusstringNonew, in-progress, resolved, archived
categorystringNoFilter by category
limitnumberNoMax results (default 50)
startAfterstringNoCursor for pagination

Example prompt:

"Show me all unresolved bug reports from the last week"


get_feedback

Get full feedback details including internal notes.

Parameters:

NameTypeRequiredDescription
feedbackIdstringYesThe feedback ID

get_feedback_by_ticket_number

Look up a feedback item by its workspace-scoped ticket number (the #245 style number shown in the dashboard).

Parameters:

NameTypeRequiredDescription
workspace_idstringYesThe workspace ID
ticket_numbernumber | stringYesThe ticket number. Accepts 245 or "#245".

Example prompt:

"Open ticket #245 in my workspace"


update_feedback_status

Update feedback status. Requires member role or higher.

Parameters:

NameTypeRequiredDescription
feedbackIdstringYesThe feedback ID
statusstringYesNew status

Example prompt:

"Mark feedback abc123 as resolved"


add_note

Add an internal note to feedback. Requires member role or higher.

Parameters:

NameTypeRequiredDescription
feedbackIdstringYesThe feedback ID
contentstringYesNote content

Example prompt:

"Add a note to feedback abc123 saying 'Fixed in release 2.1.0'"


delete_feedback

Delete a feedback item. Requires admin role or higher.

Parameters:

NameTypeRequiredDescription
feedbackIdstringYesThe feedback ID

Integrations

list_integrations

List integrations for a project.

Parameters:

NameTypeRequiredDescription
projectIdstringYesThe project ID

create_integration

Create a new integration. Requires admin role or higher.

Parameters:

NameTypeRequiredDescription
projectIdstringYesThe project ID
typestringYesslack, email, or webhook
configobjectYesIntegration-specific config

Slack config:

{
  "webhookUrl": "https://hooks.slack.com/...",
  "channel": "#feedback"
}

Email config:

{
  "emails": ["team@example.com"]
}

Webhook config:

{
  "url": "https://api.example.com/webhook",
  "secret": "whsec_..."
}

delete_integration

Delete an integration. Requires admin role or higher.

Parameters:

NameTypeRequiredDescription
integrationIdstringYesThe integration ID

Customers

list_customers

List customers in a workspace with optional filtering.

Parameters:

NameTypeRequiredDescription
workspace_idstringYesThe workspace ID
searchstringNoSearch by name, email, or phone
channelstringNoFilter by channel (e.g. widget, email, api)
tagstringNoFilter by tag
limitnumberNoMaximum number of items to return (default: 50)

Returns: Array of customers with id, name, email, phone, company, tags, feedback count, and channels

Example prompt:

"List all customers in my workspace"


get_customer

Get detailed information about a specific customer.

Parameters:

NameTypeRequiredDescription
customer_idstringYesThe customer ID

Returns: Full customer profile including emails, phones, social handles, notes, custom fields, and merge history

Example prompt:

"Show me the details of customer abc123"

Automations

list_automations

List automations for a project with optional filtering. Returns a summary for each automation — name, scope, enabled state, action count, last run timestamp, and 7-day stats.

System-generated automations (created by SLA rules) are excluded by default. Pass include_system: true to include them.

Parameters:

NameTypeRequiredDescription
project_idstringYesThe project ID
scopestringNoFilter by scope: feedback.created, feedback.updated, time.scheduled, or manual
enabledbooleanNoFilter by enabled state (omit to return all)
include_systembooleanNoInclude SLA-generated automations (default: false)
limitnumberNoMax results — default 50, max 100
cursorstringNoPagination cursor from previous response

Returns: Array of automation summaries with id, name, scope, enabled, actionsCount, lastRunAt, and runStats

Example prompts:

"List all automations in my project" "Show only enabled trigger-based rules" "Which macros exist in project abc123?"


get_automation

Get full details of a single automation, including its conditions, actions, run statistics, and metadata.

Parameters:

NameTypeRequiredDescription
automation_idstringYesThe automation ID

Returns: Full automation document including conditions, actions, stats, and source metadata

Example prompt:

"Show me the full details of automation abc123"


list_automation_runs

List recent execution runs for an automation. Ordered by most recent first.

Parameters:

NameTypeRequiredDescription
automation_idstringYesThe automation ID
limitnumberNoMax runs to return — default 20, max 50

Returns: Array of runs with runId, outcome, runAt, actionsExecuted count, feedbackId, and actor

Example prompts:

"Show the last 10 runs of my auto-assign macro" "Did automation abc123 have any errors recently?"


run_macro

Run a macro (manual automation) against a specific feedback item. The automation must have scope: "manual".

Parameters:

NameTypeRequiredDescription
automation_idstringYesThe macro automation ID
feedback_idstringYesThe feedback item to run the macro on

Returns: runId, outcome (matched / no-match / error), per-action results, automation name, and feedbackId

Example prompt:

"Run the 'Close and thank' macro on feedback #1370"

Permission Requirements

ToolMinimum Role
All list_* and get_* toolsviewer
create_*, update_*, add_notemember
delete_*admin
Integration managementadmin
run_macroadmin

On this page