Tool tree
Build surveys, share them, and understand the responses. Poll gives your browser agent tools to work alongside you, powered by WebMCP.
Implementation
gradeNot graded
gradeNot graded
get_contextAnswer
Current demo survey, your role, and what you can do. Data stays in this tab.
View tool JSON
{
"name": "get_context",
"kind": "answer",
"impl": "imperative",
"description": "Current demo survey, your role, and what you can do. Data stays in this tab.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}navigate_workspaceAction
Open a screen in this tab. Uses the survey on screen unless you pass surveyId. Does not confirm approvals.
View tool JSON
{
"name": "navigate_workspace",
"kind": "act",
"impl": "imperative",
"description": "Open a screen in this tab. Uses the survey on screen unless you pass surveyId. Does not confirm approvals.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"approvalId": {
"description": "Approval id returned by prepare_*.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
},
"destination": {
"type": "string",
"enum": [
"surveys",
"build",
"share",
"responses",
"preview",
"contacts",
"account",
"approval"
]
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
}
},
"required": [
"destination"
],
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}read_approvalAnswer
Read an approval's status and proposed changes. Does not confirm it.
View tool JSON
{
"name": "read_approval",
"kind": "answer",
"impl": "imperative",
"description": "Read an approval's status and proposed changes. Does not confirm it.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"approvalId": {
"description": "Approval id from prepare_*; optional on its approval screen.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
}
},
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}list_surveysAnswer
Up to 25 surveys, newest first. Filter by state. Pass nextCursor as pageCursor for more.
View tool JSON
{
"name": "list_surveys",
"kind": "answer",
"impl": "imperative",
"description": "Up to 25 surveys, newest first. Filter by state. Pass nextCursor as pageCursor for more.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"pageCursor": {
"description": "nextCursor from the last page.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
},
"state": {
"description": "Only surveys in this state.",
"allOf": [
{
"$ref": "#/definitions/__schema1"
}
]
}
},
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"__schema1": {
"type": "string",
"enum": [
"draft",
"scheduled",
"live",
"paused",
"closed",
"archived"
]
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}get_surveyAnswer
Read the survey: status, revision, and every question. Use revision with edit_survey.
View tool JSON
{
"name": "get_survey",
"kind": "answer",
"impl": "imperative",
"description": "Read the survey: status, revision, and every question. Use revision with edit_survey.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
}
},
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}create_surveyAction
Create a survey. You can add pages and questions in the same call. Opens it in Build.
View tool JSON
{
"name": "create_survey",
"kind": "act",
"impl": "imperative",
"description": "Create a survey. You can add pages and questions in the same call. Opens it in Build.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"addPages": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ref": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"title": {
"type": "string",
"maxLength": 500,
"default": "Questions"
},
"intro": {
"type": "string",
"maxLength": 20000
},
"position": {
"type": "integer",
"minimum": 1,
"description": "One-based position; omit to append."
}
}
}
},
"addQuestions": {
"type": "array",
"maxItems": 100,
"description": "Example: [{ \"ref\": \"ease\", \"type\": \"rating\", \"prompt\": \"How satisfied are you?\", \"min\": 1, \"max\": 5 }]",
"items": {
"type": "object",
"properties": {
"ref": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Short name for later edits or conditions in this call."
},
"page": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Page ID or same-call ref; defaults to the first page."
},
"position": {
"type": "integer",
"minimum": 1,
"description": "One-based position; omit to append."
},
"type": {
"type": "string",
"enum": [
"short_text",
"long_text",
"single_choice",
"multiple_choice",
"dropdown",
"rating",
"number",
"date",
"yes_no"
],
"description": "Question type. Use rating for a numbered scale."
},
"prompt": {
"type": "string",
"minLength": 1,
"maxLength": 20000
},
"required": {
"type": "boolean",
"default": false
},
"helpText": {
"type": "string",
"maxLength": 20000
},
"showWhen": {
"$ref": "#/$defs/showWhen"
},
"options": {
"type": "array",
"minItems": 2,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"description": "Required for choice and dropdown types."
},
"minLength": {
"type": "integer",
"minimum": 0,
"description": "Text types only."
},
"maxLength": {
"type": "integer",
"minimum": 1,
"description": "Text types only."
},
"pattern": {
"type": "string",
"maxLength": 500,
"description": "Text types only."
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"format": "date"
}
],
"description": "Required integer for rating; optional number/date for number and date types."
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"format": "date"
}
],
"description": "Required integer for rating; optional number/date for number and date types."
},
"step": {
"type": "number",
"exclusiveMinimum": 0,
"default": 1,
"description": "Rating or number types only."
},
"integer": {
"type": "boolean",
"default": false,
"description": "Number type only."
},
"minLabel": {
"type": "string",
"maxLength": 200,
"description": "Rating type only."
},
"maxLabel": {
"type": "string",
"maxLength": 200,
"description": "Rating type only."
},
"minSelections": {
"type": "integer",
"minimum": 0,
"description": "Multiple-choice type only."
},
"maxSelections": {
"type": "integer",
"minimum": 1,
"description": "Multiple-choice type only."
},
"yesLabel": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Yes/no type only."
},
"noLabel": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Yes/no type only."
}
},
"required": [
"type",
"prompt"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"type": {
"enum": [
"short_text",
"long_text",
"number",
"date",
"yes_no"
]
}
}
},
{
"properties": {
"type": {
"enum": [
"single_choice",
"multiple_choice",
"dropdown"
]
}
},
"required": [
"options"
]
},
{
"properties": {
"type": {
"const": "rating"
}
},
"required": [
"min",
"max"
]
}
]
}
},
"name": {
"description": "Survey name shown to researchers.",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"researchGoal": {
"description": "What the researcher wants to learn.",
"maxLength": 2000,
"type": "string"
},
"survey": {
"type": "object",
"additionalProperties": false,
"description": "Survey-level fields. Omitted fields stay unchanged.",
"properties": {
"title": {
"type": "string",
"maxLength": 500
},
"description": {
"type": "string",
"maxLength": 20000
},
"eligibility": {
"type": "string",
"maxLength": 2000
},
"estimatedMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"progressDisplay": {
"type": "string",
"enum": [
"none",
"bar",
"pages"
]
},
"reviewStep": {
"type": "boolean"
},
"consentLanguage": {
"type": "string",
"maxLength": 20000
},
"consentDataUse": {
"type": "string",
"minLength": 1,
"maxLength": 4000
},
"allowResume": {
"type": "boolean"
},
"allowReviseUntil": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"anonymizeByDefault": {
"type": "boolean"
}
}
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}edit_surveyAction
Save edits to this survey. Pass revision from get_survey. Returns the new revision, outline, and a check.
View tool JSON
{
"name": "edit_survey",
"kind": "act",
"impl": "imperative",
"description": "Save edits to this survey. Pass revision from get_survey. Returns the new revision, outline, and a check.",
"inputSchema": {
"type": "object",
"required": [
"revision"
],
"additionalProperties": false,
"properties": {
"revision": {
"type": "integer",
"minimum": 0,
"description": "revision from get_survey."
},
"survey": {
"type": "object",
"additionalProperties": false,
"description": "Survey-level fields. Omitted fields stay unchanged.",
"properties": {
"title": {
"type": "string",
"maxLength": 500
},
"description": {
"type": "string",
"maxLength": 20000
},
"eligibility": {
"type": "string",
"maxLength": 2000
},
"estimatedMinutes": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"progressDisplay": {
"type": "string",
"enum": [
"none",
"bar",
"pages"
]
},
"reviewStep": {
"type": "boolean"
},
"consentLanguage": {
"type": "string",
"maxLength": 20000
},
"consentDataUse": {
"type": "string",
"minLength": 1,
"maxLength": 4000
},
"allowResume": {
"type": "boolean"
},
"allowReviseUntil": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"anonymizeByDefault": {
"type": "boolean"
}
}
},
"addPages": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"ref": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"title": {
"type": "string",
"maxLength": 500,
"default": "Questions"
},
"intro": {
"type": "string",
"maxLength": 20000
},
"position": {
"type": "integer",
"minimum": 1,
"description": "One-based position; omit to append."
}
}
}
},
"updatePages": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"page"
],
"properties": {
"page": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"title": {
"type": "string",
"maxLength": 500
},
"intro": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"showWhen": {
"anyOf": [
{
"$ref": "#/$defs/showWhen"
},
{
"type": "null"
}
]
}
}
}
},
"movePages": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"page",
"position"
],
"properties": {
"page": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"position": {
"type": "integer",
"minimum": 1,
"description": "One-based position; omit to append."
}
}
}
},
"addQuestions": {
"type": "array",
"maxItems": 100,
"description": "Example: [{ \"ref\": \"ease\", \"type\": \"rating\", \"prompt\": \"How satisfied are you?\", \"min\": 1, \"max\": 5 }]",
"items": {
"type": "object",
"properties": {
"ref": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Short name for later edits or conditions in this call."
},
"page": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Page ID or same-call ref; defaults to the first page."
},
"position": {
"type": "integer",
"minimum": 1,
"description": "One-based position; omit to append."
},
"type": {
"type": "string",
"enum": [
"short_text",
"long_text",
"single_choice",
"multiple_choice",
"dropdown",
"rating",
"number",
"date",
"yes_no"
],
"description": "Question type. Use rating for a numbered scale."
},
"prompt": {
"type": "string",
"minLength": 1,
"maxLength": 20000
},
"required": {
"type": "boolean",
"default": false
},
"helpText": {
"type": "string",
"maxLength": 20000
},
"showWhen": {
"$ref": "#/$defs/showWhen"
},
"options": {
"type": "array",
"minItems": 2,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"description": "Required for choice and dropdown types."
},
"minLength": {
"type": "integer",
"minimum": 0,
"description": "Text types only."
},
"maxLength": {
"type": "integer",
"minimum": 1,
"description": "Text types only."
},
"pattern": {
"type": "string",
"maxLength": 500,
"description": "Text types only."
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"format": "date"
}
],
"description": "Required integer for rating; optional number/date for number and date types."
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"format": "date"
}
],
"description": "Required integer for rating; optional number/date for number and date types."
},
"step": {
"type": "number",
"exclusiveMinimum": 0,
"default": 1,
"description": "Rating or number types only."
},
"integer": {
"type": "boolean",
"default": false,
"description": "Number type only."
},
"minLabel": {
"type": "string",
"maxLength": 200,
"description": "Rating type only."
},
"maxLabel": {
"type": "string",
"maxLength": 200,
"description": "Rating type only."
},
"minSelections": {
"type": "integer",
"minimum": 0,
"description": "Multiple-choice type only."
},
"maxSelections": {
"type": "integer",
"minimum": 1,
"description": "Multiple-choice type only."
},
"yesLabel": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Yes/no type only."
},
"noLabel": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Yes/no type only."
}
},
"required": [
"type",
"prompt"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"type": {
"enum": [
"short_text",
"long_text",
"number",
"date",
"yes_no"
]
}
}
},
{
"properties": {
"type": {
"enum": [
"single_choice",
"multiple_choice",
"dropdown"
]
}
},
"required": [
"options"
]
},
{
"properties": {
"type": {
"const": "rating"
}
},
"required": [
"min",
"max"
]
}
]
}
},
"updateQuestions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"question"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"prompt": {
"type": "string",
"minLength": 1,
"maxLength": 20000
},
"required": {
"type": "boolean"
},
"helpText": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"showWhen": {
"anyOf": [
{
"$ref": "#/$defs/showWhen"
},
{
"type": "null"
}
]
}
}
}
},
"replaceQuestions": {
"type": "array",
"maxItems": 100,
"description": "Change a question's type, choices, or validation while preserving its ID.",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"question",
"with"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"with": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"short_text",
"long_text",
"single_choice",
"multiple_choice",
"dropdown",
"rating",
"number",
"date",
"yes_no"
],
"description": "Question type. Use rating for a numbered scale."
},
"prompt": {
"type": "string",
"minLength": 1,
"maxLength": 20000
},
"required": {
"type": "boolean",
"default": false
},
"helpText": {
"type": "string",
"maxLength": 20000
},
"showWhen": {
"$ref": "#/$defs/showWhen"
},
"options": {
"type": "array",
"minItems": 2,
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"description": "Required for choice and dropdown types."
},
"minLength": {
"type": "integer",
"minimum": 0,
"description": "Text types only."
},
"maxLength": {
"type": "integer",
"minimum": 1,
"description": "Text types only."
},
"pattern": {
"type": "string",
"maxLength": 500,
"description": "Text types only."
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"format": "date"
}
],
"description": "Required integer for rating; optional number/date for number and date types."
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"format": "date"
}
],
"description": "Required integer for rating; optional number/date for number and date types."
},
"step": {
"type": "number",
"exclusiveMinimum": 0,
"default": 1,
"description": "Rating or number types only."
},
"integer": {
"type": "boolean",
"default": false,
"description": "Number type only."
},
"minLabel": {
"type": "string",
"maxLength": 200,
"description": "Rating type only."
},
"maxLabel": {
"type": "string",
"maxLength": 200,
"description": "Rating type only."
},
"minSelections": {
"type": "integer",
"minimum": 0,
"description": "Multiple-choice type only."
},
"maxSelections": {
"type": "integer",
"minimum": 1,
"description": "Multiple-choice type only."
},
"yesLabel": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Yes/no type only."
},
"noLabel": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Yes/no type only."
}
},
"required": [
"type",
"prompt"
],
"additionalProperties": false,
"oneOf": [
{
"properties": {
"type": {
"enum": [
"short_text",
"long_text",
"number",
"date",
"yes_no"
]
}
}
},
{
"properties": {
"type": {
"enum": [
"single_choice",
"multiple_choice",
"dropdown"
]
}
},
"required": [
"options"
]
},
{
"properties": {
"type": {
"const": "rating"
}
},
"required": [
"min",
"max"
]
}
]
}
}
}
},
"moveQuestions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"question",
"page",
"position"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"page": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"position": {
"type": "integer",
"minimum": 1,
"description": "One-based position; omit to append."
}
}
}
},
"deleteQuestions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
},
"deletePages": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"type": "string"
}
},
"$defs": {
"showWhen": {
"description": "A simple condition, comparison, presence check, or all/any group. References must point to earlier questions.",
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"question",
"equals"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"equals": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"question",
"operator",
"value"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"operator": {
"enum": [
"not_equals",
"contains",
"greater_than",
"less_than"
]
},
"value": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"question",
"operator"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"operator": {
"enum": [
"answered",
"unanswered"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"all"
],
"properties": {
"all": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/$defs/flatCondition"
}
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"any"
],
"properties": {
"any": {
"type": "array",
"minItems": 1,
"maxItems": 20,
"items": {
"$ref": "#/$defs/flatCondition"
}
}
}
}
]
},
"flatCondition": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": [
"question",
"equals"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"equals": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"question",
"operator",
"value"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"operator": {
"enum": [
"not_equals",
"contains",
"greater_than",
"less_than"
]
},
"value": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": [
"question",
"operator"
],
"properties": {
"question": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"operator": {
"enum": [
"answered",
"unanswered"
]
}
}
}
]
}
},
"examples": [
{
"revision": 0,
"addQuestions": [
{
"ref": "ease",
"type": "rating",
"prompt": "How easy was it to use?",
"required": true,
"min": 1,
"max": 5
},
{
"ref": "use_again",
"type": "yes_no",
"prompt": "Would you use it again?",
"required": true
},
{
"type": "long_text",
"prompt": "What could we improve?",
"showWhen": {
"question": "use_again",
"equals": "no"
}
}
]
},
{
"revision": 4,
"updateQuestions": [
{
"question": "QUESTION_ID",
"prompt": "Updated wording",
"required": true
}
],
"moveQuestions": [
{
"question": "QUESTION_ID",
"page": "PAGE_ID",
"position": 1
}
],
"deleteQuestions": [
"UNWANTED_QUESTION_ID"
]
}
]
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}check_surveyAnswer
Check the saved survey for content, logic, and accessibility issues, and what changed since the last release.
View tool JSON
{
"name": "check_survey",
"kind": "answer",
"impl": "imperative",
"description": "Check the saved survey for content, logic, and accessibility issues, and what changed since the last release.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
}
},
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}get_sharingAnswer
Read the current share: settings, links, counts, and release history.
View tool JSON
{
"name": "get_sharing",
"kind": "answer",
"impl": "imperative",
"description": "Read the current share: settings, links, counts, and release history.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"shareId": {
"description": "Defaults to the current share.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
}
},
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}configure_sharingAction
Update share settings. Pass revision from get_sharing, or newShare to start a draft. Opening it still needs prepare_share and a person.
View tool JSON
{
"name": "configure_sharing",
"kind": "act",
"impl": "imperative",
"description": "Update share settings. Pass revision from get_sharing, or newShare to start a draft. Opening it still needs prepare_share and a person.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"revision": {
"$ref": "#/definitions/__schema0"
},
"accessMode": {
"$ref": "#/definitions/__schema1"
},
"endsAt": {
"$ref": "#/definitions/__schema2"
},
"invitationPolicy": {
"$ref": "#/definitions/__schema5"
},
"name": {
"$ref": "#/definitions/__schema6"
},
"quotaRules": {
"$ref": "#/definitions/__schema7"
},
"responseTarget": {
"$ref": "#/definitions/__schema12"
},
"slug": {
"$ref": "#/definitions/__schema13"
},
"startsAt": {
"$ref": "#/definitions/__schema14"
},
"newShare": {
"description": "Start a new draft share before applying these settings.",
"type": "boolean"
},
"shareId": {
"description": "Defaults to the current share.",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"type": "string"
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"type": "string"
}
},
"required": [],
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"__schema1": {
"type": "string",
"enum": [
"public",
"unlisted",
"authenticated",
"invite-only"
]
},
"__schema2": {
"anyOf": [
{
"$ref": "#/definitions/__schema3"
},
{
"type": "null"
}
]
},
"__schema3": {
"description": "An ISO-8601 timestamp; stored normalized to UTC.",
"allOf": [
{
"$ref": "#/definitions/__schema4"
}
]
},
"__schema4": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"__schema5": {
"type": "object",
"properties": {
"expiresInDays": {
"type": "integer",
"minimum": 1,
"maximum": 365
},
"singleUse": {
"type": "boolean"
}
},
"required": [
"expiresInDays",
"singleUse"
],
"additionalProperties": false
},
"__schema6": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"__schema7": {
"type": "object",
"properties": {
"rules": {
"$ref": "#/definitions/__schema8"
}
},
"required": [
"rules"
],
"additionalProperties": false
},
"__schema8": {
"maxItems": 20,
"type": "array",
"items": {
"$ref": "#/definitions/__schema9"
}
},
"__schema9": {
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/__schema10"
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"target": {
"$ref": "#/definitions/__schema11"
},
"when": {
"oneOf": [
{
"type": "object",
"properties": {
"questionId": {
"$ref": "#/definitions/__schema10"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"greater_than",
"less_than"
]
},
"value": {
"type": [
"string",
"number",
"boolean"
]
}
},
"required": [
"questionId",
"operator",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"questionId": {
"$ref": "#/definitions/__schema10"
},
"operator": {
"type": "string",
"enum": [
"answered",
"unanswered"
]
}
},
"required": [
"questionId",
"operator"
],
"additionalProperties": false
}
]
}
},
"required": [
"id",
"label",
"target",
"when"
],
"additionalProperties": false
},
"__schema10": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
},
"__schema11": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 1000000
},
"__schema12": {
"anyOf": [
{
"$ref": "#/definitions/__schema11"
},
{
"type": "null"
}
]
},
"__schema13": {
"type": "string",
"minLength": 3,
"maxLength": 80,
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"__schema14": {
"anyOf": [
{
"$ref": "#/definitions/__schema3"
},
{
"type": "null"
}
]
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}prepare_shareAction
Prepare a demo share change for review. Publishing is simulated; no public survey is created.
View tool JSON
{
"name": "prepare_share",
"kind": "act",
"impl": "imperative",
"description": "Prepare a demo share change for review. Publishing is simulated; no public survey is created.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"open",
"schedule",
"pause",
"resume",
"close",
"archive",
"update_release"
],
"description": "The lifecycle move to prepare."
},
"notes": {
"description": "Optional release notes recorded when a new release is created.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
},
"shareId": {
"description": "Defaults to the current share.",
"allOf": [
{
"$ref": "#/definitions/__schema1"
}
]
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema1"
}
]
}
},
"required": [
"action"
],
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"maxLength": 2000
},
"__schema1": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}list_contact_groupsAnswer
Every contact group and its size. Contact details stay private.
View tool JSON
{
"name": "list_contact_groups",
"kind": "answer",
"impl": "imperative",
"description": "Every contact group and its size. Contact details stay private.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {},
"additionalProperties": false
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}count_contactsAnswer
Count contacts in a group that match your filters. Returns the count, not the people.
View tool JSON
{
"name": "count_contacts",
"kind": "answer",
"impl": "imperative",
"description": "Count contacts in a group that match your filters. Returns the count, not the people.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"contactGroupId": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "Contact group id from list_contact_groups."
},
"requireAll": {
"description": "Conditions every counted contact must satisfy; omit to count the whole group.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
}
},
"required": [
"contactGroupId"
],
"additionalProperties": false,
"definitions": {
"__schema0": {
"maxItems": 10,
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
"__schema1": {
"type": "object",
"properties": {
"attribute": {
"$ref": "#/definitions/__schema2"
},
"operator": {
"$ref": "#/definitions/__schema3"
},
"value": {
"$ref": "#/definitions/__schema4"
}
},
"required": [
"attribute",
"operator"
],
"additionalProperties": false
},
"__schema2": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"__schema3": {
"type": "string",
"enum": [
"equals",
"exists",
"not_equals"
]
},
"__schema4": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}prepare_invitationsAction
Draft demo invitations for review. Confirmation stays in this tab; no email is sent.
View tool JSON
{
"name": "prepare_invitations",
"kind": "act",
"impl": "imperative",
"description": "Draft demo invitations for review. Confirmation stays in this tab; no email is sent.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"contactGroupId": {
"$ref": "#/definitions/__schema0"
},
"filters": {
"default": {
"requireAll": []
},
"type": "object",
"properties": {
"requireAll": {
"default": [],
"maxItems": 10,
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
}
},
"additionalProperties": false
},
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"body": {
"type": "string",
"minLength": 1,
"maxLength": 5000
},
"shareId": {
"description": "Defaults to the current share.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
}
},
"required": [
"contactGroupId",
"subject",
"body"
],
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
},
"__schema1": {
"type": "object",
"properties": {
"attribute": {
"$ref": "#/definitions/__schema2"
},
"operator": {
"$ref": "#/definitions/__schema3"
},
"value": {
"$ref": "#/definitions/__schema4"
}
},
"required": [
"attribute",
"operator"
],
"additionalProperties": false
},
"__schema2": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"__schema3": {
"type": "string",
"enum": [
"equals",
"exists",
"not_equals"
]
},
"__schema4": {
"default": "",
"type": "string",
"maxLength": 2000
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}summarize_responsesAnswer
Totals and a summary of every released question, including up to 5 text samples. Filter by share, dates, or questionIds.
View tool JSON
{
"name": "summarize_responses",
"kind": "answer",
"impl": "imperative",
"description": "Totals and a summary of every released question, including up to 5 text samples. Filter by share, dates, or questionIds.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"from": {
"$ref": "#/definitions/__schema0"
},
"questionIds": {
"description": "Return only these questions; omit for every released question.",
"allOf": [
{
"$ref": "#/definitions/__schema2"
}
]
},
"shareId": {
"description": "Defaults to the current share.",
"allOf": [
{
"$ref": "#/definitions/__schema4"
}
]
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema4"
}
]
},
"to": {
"$ref": "#/definitions/__schema0"
}
},
"additionalProperties": false,
"definitions": {
"__schema0": {
"description": "Date as YYYY-MM-DD.",
"allOf": [
{
"$ref": "#/definitions/__schema1"
}
]
},
"__schema1": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"__schema2": {
"maxItems": 20,
"type": "array",
"items": {
"$ref": "#/definitions/__schema3"
}
},
"__schema3": {
"description": "Question id from get_survey.",
"allOf": [
{
"$ref": "#/definitions/__schema4"
}
]
},
"__schema4": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}find_responsesAnswer
Find submitted responses. Default 25 per page (max 50). Ask for answers with includeQuestionIds.
View tool JSON
{
"name": "find_responses",
"kind": "answer",
"impl": "imperative",
"description": "Find submitted responses. Default 25 per page (max 50). Ask for answers with includeQuestionIds.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"answerCriteria": {
"description": "All answer conditions a response must satisfy; at most 5.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
},
"contactGroupId": {
"description": "Contact group the response's invitation came from.",
"allOf": [
{
"$ref": "#/definitions/__schema2"
}
]
},
"from": {
"$ref": "#/definitions/__schema3"
},
"includeQuestionIds": {
"description": "Question answers to include; defaults to questions used in answerCriteria.",
"allOf": [
{
"$ref": "#/definitions/__schema5"
}
]
},
"limit": {
"description": "Page size; defaults to 25, maximum 50.",
"allOf": [
{
"$ref": "#/definitions/__schema7"
}
]
},
"pageCursor": {
"description": "nextCursor from the last page.",
"allOf": [
{
"$ref": "#/definitions/__schema8"
}
]
},
"qualityFlag": {
"type": "string",
"minLength": 1,
"maxLength": 120
},
"shareId": {
"description": "Defaults to the current share.",
"allOf": [
{
"$ref": "#/definitions/__schema2"
}
]
},
"status": {
"description": "Defaults to submitted. Pass any to include unfinished responses.",
"allOf": [
{
"$ref": "#/definitions/__schema9"
}
]
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema2"
}
]
},
"to": {
"$ref": "#/definitions/__schema3"
}
},
"additionalProperties": false,
"definitions": {
"__schema0": {
"maxItems": 5,
"type": "array",
"items": {
"$ref": "#/definitions/__schema1"
}
},
"__schema1": {
"oneOf": [
{
"type": "object",
"properties": {
"questionId": {
"$ref": "#/definitions/__schema2"
},
"operator": {
"type": "string",
"enum": [
"equals",
"not_equals",
"contains",
"greater_than",
"less_than"
]
},
"value": {
"type": [
"string",
"number",
"boolean"
]
}
},
"required": [
"questionId",
"operator",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"questionId": {
"$ref": "#/definitions/__schema2"
},
"operator": {
"type": "string",
"enum": [
"answered",
"unanswered"
]
}
},
"required": [
"questionId",
"operator"
],
"additionalProperties": false
}
]
},
"__schema2": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
},
"__schema3": {
"description": "Date as YYYY-MM-DD.",
"allOf": [
{
"$ref": "#/definitions/__schema4"
}
]
},
"__schema4": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"__schema5": {
"maxItems": 10,
"type": "array",
"items": {
"$ref": "#/definitions/__schema6"
}
},
"__schema6": {
"description": "Question id from get_survey.",
"allOf": [
{
"$ref": "#/definitions/__schema2"
}
]
},
"__schema7": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"__schema8": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"__schema9": {
"type": "string",
"enum": [
"submitted",
"in-progress",
"any"
]
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}summarize_feedbackAction
Feedback counts and up to 25 samples per page. Filter by share, category, or review status.
View tool JSON
{
"name": "summarize_feedback",
"kind": "act",
"impl": "imperative",
"description": "Feedback counts and up to 25 samples per page. Filter by share, category, or review status.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"experience",
"technical"
]
},
"pageCursor": {
"description": "nextCursor from the last page.",
"allOf": [
{
"$ref": "#/definitions/__schema0"
}
]
},
"shareId": {
"description": "Defaults to the current share.",
"allOf": [
{
"$ref": "#/definitions/__schema1"
}
]
},
"status": {
"type": "string",
"enum": [
"new",
"reviewed"
]
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema1"
}
]
}
},
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"__schema1": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}prepare_exportAction
Prepare a demo export for review. After confirmation, the person can download a file from this tab.
View tool JSON
{
"name": "prepare_export",
"kind": "act",
"impl": "imperative",
"description": "Prepare a demo export for review. After confirmation, the person can download a file from this tab.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"anonymized": {
"default": true,
"type": "boolean"
},
"fields": {
"minItems": 1,
"maxItems": 9,
"type": "array",
"items": {
"$ref": "#/definitions/__schema0"
}
},
"format": {
"default": "csv",
"type": "string",
"enum": [
"csv",
"json"
]
},
"shareId": {
"allOf": [
{
"$ref": "#/definitions/__schema1"
}
]
},
"surveyId": {
"description": "Defaults to the survey on screen.",
"allOf": [
{
"$ref": "#/definitions/__schema1"
}
]
}
},
"required": [
"fields"
],
"additionalProperties": false,
"definitions": {
"__schema0": {
"type": "string",
"enum": [
"response_reference",
"share",
"status",
"contact_group",
"started_at",
"submitted_at",
"quality_flags",
"participant_linkage",
"answers"
]
},
"__schema1": {
"type": "string",
"pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$",
"description": "A stable, lexicographically sortable ULID."
}
}
},
"page": "/demo/surveys/01K00000000000000000000001/build"
}