Tool reference
The Cognitive3D MCP Server provides 48 tools. Your AI assistant picks the right tool for each request, so you do not need to name a tool yourself. This page lists every tool and whether it changes data. The list is generated from the server, so it matches the tools the server provides.
35 tools only read data, and 13 tools change data. Changes require an organization-admin or project-admin role. See Tools that change data.
The Changes data column means:
- No. The tool only reads data.
- Yes, after you confirm. The tool previews the change, and nothing changes until you confirm.
- Yes, some changes after you confirm. Some changes apply immediately. The rest are previewed and wait for you to confirm.
- Yes, immediately. The change applies as soon as the tool runs.
Organization
For examples and parameters, see Organization.
| Tool | What it does | Changes data |
|---|---|---|
get_organization_summary |
Gives an overview of your organization, with every project, its ID, and recent activity. | No. |
get_organization_trends |
Shows monthly session trends across your organization, with growth patterns and recommendations. | No. |
Projects
For examples and parameters, see Projects.
| Tool | What it does | Changes data |
|---|---|---|
get_project_details |
Shows a project's details, including its scenes, scene versions, and session statistics. | No. |
compare_projects |
Compares sessions, session length, engagement, and objectives across two to five projects. | No. |
Sessions
For examples and parameters, see Sessions.
| Tool | What it does | Changes data |
|---|---|---|
get_scene_sessions |
Shows sessions, device breakdown, and engagement metrics for one scene version. | No. |
get_sessions_by_participant |
Finds sessions by participant name or ID and groups them by participant. | No. |
get_project_users |
Lists the participants and devices that recorded sessions in a project, with search and sorting. | No. |
get_average_session_times |
Gives the average session length for a project, in minutes. | No. |
get_average_session_durations_by_scene |
Shows the average time participants spend in each scene of a project. | No. |
Scores and devices
| Tool | What it does | Changes data |
|---|---|---|
get_score |
Gives one score for a project, such as app performance, frame rate, comfort, cyberwellness, or time spent sitting and standing. | No. |
get_device_info |
Shows which devices recorded your sessions, by device category, model, platform, and hardware. | No. |
get_cognitive3d_sdk_versions |
Shows which Cognitive3D SDK versions recorded your sessions, with session counts per version. | No. |
get_user_demographics |
Shows the playable space sizes participants use and the countries and regions sessions come from. | No. |
get_head_orientation_widget |
Lists how often participants face each direction, in physical and virtual space. | No. |
Objectives
For examples and parameters, see Objectives.
| Tool | What it does | Changes data |
|---|---|---|
get_project_objectives |
Lists a project's objectives with their steps and whether each one is enabled. | No. |
get_project_objectives_count |
Counts a project's active and inactive objectives. | No. |
get_objective_components_analysis |
Analyzes how complex your objectives are, from their steps and event patterns. | No. |
get_objective_results |
Shows success and failure rates for a project's objectives. | No. |
create_objective |
Creates an objective from gaze, fixation, event, and zone steps, and re-scores up to 30 days of past sessions against it. | Yes, after you confirm. |
update_objective |
Renames, re-describes, enables, or disables an objective, or replaces its steps as a new version, which needs your confirmation. | Yes, some changes after you confirm. |
delete_objective |
Permanently deletes an objective and all of its versions. | Yes, after you confirm. |
ExitPoll surveys
For examples and parameters, see ExitPoll surveys.
| Tool | What it does | Changes data |
|---|---|---|
get_exitpoll_configuration |
Shows a project's ExitPoll hooks, the question set version each one uses, and every question set version. | No. |
get_exitpoll_question_set |
Shows the full questions in a question set, ready to edit into a new version. | No. |
create_exitpoll_question_set |
Creates a question set, or a new version of an existing one. | Yes, after you confirm. |
archive_exitpoll_question_set |
Archives a question set, or one version of it. | Yes, after you confirm. |
create_exitpoll_hook |
Creates a hook and can assign a question set version to it. | Yes, after you confirm. |
update_exitpoll_hook |
Assigns a different question set version to a hook, removes its assignment, or changes its description. | Yes, after you confirm. |
Zones
For examples and parameters, see Zones.
| Tool | What it does | Changes data |
|---|---|---|
list_zones |
Lists a project's zones with their shapes. | No. |
list_shapes |
Lists the shapes on one scene and the zones each shape belongs to. | No. |
get_zone_visits |
Shows visits, visiting sessions, mean visit length, and total dwell time per zone. | No. |
create_zone_from_shapes |
Creates shapes and a zone together, as a draft to review on the dashboard or published immediately. | Yes, after you confirm. |
create_zone |
Groups existing shapes into a new zone. | Yes, after you confirm. |
update_zone |
Renames or re-describes a zone. | Yes, immediately. |
delete_zone |
Deletes a zone, and optionally its shapes. | Yes, after you confirm. |
create_shape |
Creates one draft shape on a scene. | Yes, after you confirm. |
delete_shape |
Deletes a shape that is not in any zone. | Yes, after you confirm. |
Charts
For examples and parameters, see Charts.
| Tool | What it does | Changes data |
|---|---|---|
query_data |
Charts or tabulates any field, with grouping and filters. | No. |
list_slicer_fields |
Lists the fields you can chart for a project, including your own session and event properties. | No. |
get_field_values |
Lists the distinct values of one field, for building filters. | No. |
query_relationship |
Plots two numeric measures against each other, one point per session. | No. |
query_objective_funnel |
Draws a step-by-step funnel for one multi-step objective. | No. |
query_metric_profile |
Draws a radar chart of a score's component sub-scores. | No. |
query_exitpoll |
Charts ExitPoll survey responses, with a chart suited to each question type. | No. |
query_head_orientation |
Draws a radial profile of head orientation in physical and virtual space. | No. |
query_spatial_heatmap |
Draws a top-down heatmap of gaze, fixation, or position on one scene. | No. |
query_geo_distribution |
Draws a world map of sessions by country. | No. |
query_hierarchy |
Draws a treemap of sessions by device category and family. | No. |
query_scene_flow |
Draws the order in which participants visit scenes across their sessions. | No. |
If you have a question or any feedback about our documentation please use the Intercom button (purple circle) in the lower right corner of any web page or join our Discord.