Guides and Surveys MCP tools
Available tools
| Tool | Description |
|---|---|
list_guides_surveys | List guides and surveys in a project, with filters by type, platform, creator, date range, and archived status. |
get_guide_or_survey | Retrieve full details for a single guide or survey by ID, including variants, step content, targeting rules, and trigger configuration. |
list_guides_surveys
Use list_guides_surveys to discover and compare guides and surveys across a project. This tool is best for overview and summary questions: what is live, what is scheduled, and what is in an experiment.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project ID (appId) to list guides and surveys for. |
types | array | No | Filter by type. Accepts "GUIDE", "SURVEY", or both. Defaults to both. |
platform | string | No | Filter by target platform: web, ios, android, react-native, desktop, or flutter. The web value also matches items with no platform set. |
createdAfter | string (ISO 8601) | No | Lower bound on creation timestamp (inclusive). |
createdBefore | string (ISO 8601) | No | Upper bound on creation timestamp (inclusive). |
createdBy | string | No | Filter by the email or login ID of the user who created the item. |
includeArchived | boolean | No | Include archived items. Defaults to false. |
limit | integer | No | Number of items per page. Defaults to 50, maximum 200. |
cursor | string | No | Pagination cursor from a previous response's nextCursor. Omit for the first page. |
Example prompts
What guides and surveys are currently live?
Which surveys are running on iOS?
Show me all guides created by alice@example.com in Q1 2025.
List all archived surveys.
get_guide_or_survey
Use get_guide_or_survey to deep-dive into a single guide or survey after finding it with list_guides_surveys. This tool returns variant configurations, step content, page targeting rules, trigger settings, and rollout state.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | string | Yes | The project ID (appId) the guide or survey belongs to. |
nudgeId | string | Yes | The ID of the guide or survey to retrieve. |
Example prompts
Show me the full configuration for guide 15731.
Is the onboarding survey live or scheduled?
What pages does this guide target?
What steps does this product tour include?
Can users snooze or dismiss this guide?
Common workflows
Audit active nudges
List all published and experiment-running guides and surveys to review what users are seeing:
List all non-archived guides and surveys in project 574019.
Which guides are in an experiment right now?
Review targeting and content before a launch
After finding an item with list_guides_surveys, use get_guide_or_survey to verify its targeting rules and step content before publishing:
Show me the page targeting and trigger configuration for survey 101.
What copy appears in each step of guide 15728?
Platform-specific audits
Filter by platform to review mobile or web experiences separately:
What iOS surveys are currently published?
Which web guides were created in the last 30 days?
Connect the MCP server
To use these tools, connect the Amplitude MCP server to your AI editor. Refer to Amplitude MCP Server for setup instructions.Was this helpful?