> For the complete documentation index, see [llms.txt](https://help.dscout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.dscout.com/dscout-ai/dscout-mcp/dscout-mcp-tools.md).

# Dscout MCP tools

The Dscout MCP lets you build and launch studies and interact with your data in a conversational way without having to leave your favorite AI tools. To do that, the MCP uses the following tool calls to read and write data within your Dscout account.

### Account management

| Tool                     | Access | Description                                                                      |
| ------------------------ | ------ | -------------------------------------------------------------------------------- |
| `list_accounts`          | Read   | Lists all Dscout accounts you have access to.                                    |
| `get_account_balance`    | Read   | Lists the balance of incentives and activity credits in your Dscout account.     |
| `get_researcher_profile` | Read   | Lists the name and email address associated with your individual Dscout account. |

### Projects and workspaces

| Tool              | Access | Description                                                     |
| ----------------- | ------ | --------------------------------------------------------------- |
| `create_project`  | Write  | Creates a new project in your Dscout account.                   |
| `list_projects`   | Read   | Lists all projects you have access to in your Dscout account.   |
| `list_workspaces` | Read   | Lists all workspaces you have access to in your Dscout account. |

### Entries and responses

| Tool                    | Access | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ----------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list_entries`          | Read   | <p>Lists accepted submissions from a study, including:<br></p><ul><li>Participant name.</li><li>Date and time of submission.</li><li>Submission status (accepted or queued for payment).</li></ul><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Note:</strong> The queued for payment submission status indicates submissions within the 7-day window you have to review submissions before they are automatically paid.</p></div> |
| `get_entry`             | Read   | Retrieves details for a single entry, including every question response and transcript (if applicable).                                                                                                                                                                                                                                                                                                                                                                            |
| `filter_entries`        | Read   | Identifies entries based on your stated criteria. For example, “Find all entries that mention Amazon” will call this tool.                                                                                                                                                                                                                                                                                                                                                         |
| `list_clips`            | Read   | Provides a list of clips from your study, including a direct link to view them in the Dscout web app.                                                                                                                                                                                                                                                                                                                                                                              |
| `create_clip`           | Write  | Creates a new clip from a response entry.                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `cite_evidence`         | Read   | Cites specific evidence from a participant’s response to support a stated research finding. For example, “Tell me why this participant found the task difficult” will call this tool.                                                                                                                                                                                                                                                                                              |
| `get_transcript_window` | Read   | Retrieves a windowed page of an entry's session transcript for paging through a long interview or response transcript instead of pulling one large block.                                                                                                                                                                                                                                                                                                                          |
| `list_timeline_events`  | Read   | Lists timeline events for a recording within a study. For example, click events in a usability test, flagged moments in an AI moderated study, or markers in an interview session.                                                                                                                                                                                                                                                                                                 |

### Recruiting

{% hint style="info" %}
**Note:** The Dscout MCP does not currently support recruiting from Partner Panels or Private Panels, nor does it support behavioral or custom targeting attributes.
{% endhint %}

| Tool                      | Access | Description                                                                                                                                                                           |
| ------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `set_target_attributes`   | Write  | Creates, adds, or edits a targeting attribute from your study.                                                                                                                        |
| `delete_target_attribute` | Write  | Removes a targeting attribute from your study.                                                                                                                                        |
| `set_recruiting_method`   | Write  | <p>Assigns a recruitment method to your study:<br></p><ul><li>Recruit from the Dscout Scout Panel.</li><li>Add from a Dscout screener.</li><li>Bring your own participants.</li></ul> |
| `set_incentive`           | Write  | Sets the incentive amount to be paid to each participant in your study.                                                                                                               |
| `rate_applicants`         | Write  | Sets the fit rating (Eligible/Low quality/Bad fit/Possible fit/Good fit) in bulk on standalone screener applicants.                                                                   |

### Screeners

| Tool                       | Access | Description                                  |
| -------------------------- | ------ | -------------------------------------------- |
| `upsert_screener_question` | Write  | Creates and/or updates a screener question.  |
| `delete_screener_question` | Write  | Removes a screener question from your study. |

### Study setup

| Tool                      | Access | Description                                                                                                                                                                                                                                                                                                                            |
| ------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `draft_study_plan`        | Write  | Drafts a full study plan (targeting attributes, screener questions, study questions).                                                                                                                                                                                                                                                  |
| `apply_study_plan`        | Write  | Applies a previously drafted plan to a study.                                                                                                                                                                                                                                                                                          |
| `update_mission_settings` | Write  | <p>Edits the settings in an existing usability test, including:</p><ul><li>Name.</li><li>Device type.</li><li>Recording option.</li><li>Study description.</li><li>Incentive amount.</li><li>Participant limit.</li><li>Time frame.</li><li>Custom instructions.</li><li>Custom thank-you message.</li><li>Knockout message.</li></ul> |
| `list_mission_templates`  | Read   | <p>Lists study templates available in your Dscout account.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Note:</strong> Only usability test templates are currently supported.</p></div>                                                                                            |

### Question groups and multi-variate testing

| Tool                         | Access | Description                                                                      |
| ---------------------------- | ------ | -------------------------------------------------------------------------------- |
| `upsert_question_group`      | Write  | Creates and/or updates a question group in your study.                           |
| `set_question_group_members` | Write  | Assigns questions to (or moves questions to a new) question group in your study. |
| `delete_question_group`      | Write  | Removes a question group from your study.                                        |

### Study questions

| Tool                      | Access | Description                                                              |
| ------------------------- | ------ | ------------------------------------------------------------------------ |
| `upsert_study_question`   | Write  | Creates and/or updates a study question.                                 |
| `delete_study_question`   | Write  | Removes a study question from your study.                                |
| `add_questions_from_bank` | Write  | Adds a question from a question bank to your study.                      |
| `list_question_banks`     | Read   | Lists available questions from the question bank in your Dscout account. |

### Media and stimuli

| Tool                | Access | Description                                                                                                                                                                                                                                                                                                                                        |
| ------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `prep_stim_upload`  | Write  | <p>Prepares a file to be uploaded as a stimulus to a question in your study. This tool prompts you to provide your image file in the chat with your AI tool.</p><p>For information on supported file types and limits, see <a href="/study-basics/question-types/question-settings-and-organization/question-stimuli.md">Question stimuli</a>.</p> |
| `set_mission_image` | Write  | Assigns a hero image to your study.                                                                                                                                                                                                                                                                                                                |

### Study management and analysis

| Tool                         | Access | Description                                                                                                                                                                                                                                                                         |
| ---------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `get_study`                  | Read   | Gets details about a specific study, including title, launch status, and more.                                                                                                                                                                                                      |
| `list_studies`               | Read   | Lists studies across the projects you have access to in your Dscout account.                                                                                                                                                                                                        |
| `clone_study`                | Write  | Duplicates an existing study, letting you enter a new study title and destination project (if desired). Recruitment criteria, questions, and stimuli remain the same.                                                                                                               |
| `create_study_from_template` | Write  | Creates a new study from a template.                                                                                                                                                                                                                                                |
| `move_study_to_project`      | Write  | <p>Relocates an existing study from one project to another in your Dscout account.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p><strong>Note:</strong> It is not possible to move studies from one Dscout account to another.</p></div> |
| `preview_study`              | Write  | Generates a preview link for your study through which you can preview the study as a participant would see it.                                                                                                                                                                      |
| `launch_study`               | Write  | Launches your study, opening it to participants.                                                                                                                                                                                                                                    |
| `check_launch_readiness`     | Read   | Verifies whether your study meets the required launch criteria, reporting any unmet requirements.                                                                                                                                                                                   |
| `query_study`                | Read   | Retrieves raw response data from your study.                                                                                                                                                                                                                                        |
| `compute_study_metric`       | Read   | Calculates quantitative metrics from your raw response data. For example, “How many participants rated difficulty 3 or higher?” will call this tool.                                                                                                                                |

### Analysis artifacts and tags

| Tool                          | Access | Description                                                                                                                                                                                                                                                                 |
| ----------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `get_analysis_artifact`       | Read   | Retrieves a single AI-generated analysis artifact for a study. For example, a summary, theme, notable moment, or emerging theme.                                                                                                                                            |
| `list_analysis_artifacts`     | Read   | Lists specific AI-generated analysis artifacts in a single study.                                                                                                                                                                                                           |
| `discover_analysis_artifacts` | Read   | Lists what categories of AI-generated analysis are available for a single study and where they live. For example, AI notable moments in a usability test session or AI themes in an overall diary study. Specific results are then pulled using `list_analysis_artifacts` . |
| `create_tag_group`            | Write  | Creates a new, empty tag group in a study for organizing tags. This does not create a tag itself, which is achieved using `create_tag`.                                                                                                                                     |
| `create_tag`                  | Write  | Creates a new tag within a study.                                                                                                                                                                                                                                           |
| `list_tags`                   | Read   | Lists tags, tag groups, and their existing applications within a study.                                                                                                                                                                                                     |
| `apply_tag`                   | Write  | Applies an existing tag to a specific response, text selection, or transcript moment in an entry. This does not create the tag itself, which is achieved using `create_tag`.                                                                                                |
| `unapply_tag`                 | Write  | Removes a tag from a specific entry without deleting the tag definition itself.                                                                                                                                                                                             |

### Media exports and highlight reels

| Tool                       | Access | Description                                                                                                                                                                                                                                                                          |
| -------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `create_media_export`      | Write  | <p>Initiates the generation of a downloadable export of study-related media, including session recordings, CSV files, and more.<br><br>For more information on available exports, see <a href="/study-basics/analyze-studies/how-can-i-export-my-data.md">Export study data</a>.</p> |
| `get_media_export`         | Read   | Checks the status of exports generated by `create_media_export`, letting you know whether an export is ready to download, still in progress, or unavailable.                                                                                                                         |
| `create_media_download`    | Write  | Creates a local download link for one media resource. For example, stimuli, session recording, or video response.                                                                                                                                                                    |
| `create_media_composition` | Write  | Creates a combined picture-in-picture video for one entry, layering a participant's screen share and camera into a single video.                                                                                                                                                     |
| `list_media`               | Read   | Lists what media exists within a study. For example, photo responses, stimuli, clips, and more.                                                                                                                                                                                      |
| `create_reel`              | Write  | Creates a highlight reel from existing clips in a study.                                                                                                                                                                                                                             |
| `get_reel`                 | Read   | Retrieves an existing highlight reel from within a study.                                                                                                                                                                                                                            |
| `list_reels`               | Read   | Lists all existing highlight reels within a study.                                                                                                                                                                                                                                   |

### Learn more

Learn more about the Dscout MCP in these articles:

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Dscout MCP overview</td><td><a href="/dscout-ai/dscout-mcp.md">Dscout MCP</a></td></tr><tr><td>Set up the Dscout MCP</td><td><a href="/dscout-ai/dscout-mcp/set-up-the-dscout-mcp.md">Set up the Dscout MCP</a></td></tr><tr><td>MCP prompt library</td><td><a href="/dscout-ai/dscout-mcp/dscout-mcp-prompt-library.md">Dscout MCP prompt library</a></td></tr><tr><td>MCP best practices</td><td><a href="/dscout-ai/dscout-mcp/dscout-mcp-best-practices.md">Dscout MCP best practices</a></td></tr><tr><td>Troubleshooting</td><td><a href="/dscout-ai/dscout-mcp/troubleshoot-the-dscout-mcp.md">Troubleshoot the Dscout MCP</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.dscout.com/dscout-ai/dscout-mcp/dscout-mcp-tools.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.