Visual website feedback your coding agent applies: pin change requests on the live site over MCP.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Bearer ppk_... workspace API key. Omit for keyless discovery; required for tool calls.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Server-side deterministic groupings (by selector / page / reviewer / keyword) plus heuristic suggested_clusters of change requests. Set ai_clusters="auto" (default) to also request semantic clustering via the host's MCP sampling capability — returns ai_clustering_hint for the host AI to apply inline if sampling is unsupported. Use this BEFORE drilling into individual CRs to find patterns across the dataset.
The project slug.
Which feedback kinds to pull into the analysis: change_requested (a decision requesting a change), rejected (a decision rejecting the pick), approved (a decision approving the pick), comment (a comment-only pin, no decision). Defaults to ['change_requested'].
Which deterministic groupings to compute: selector (by CSS selector), page (by page URL), reviewer (by reviewer). Defaults to ['selector', 'page']. Keyword extraction (common_keywords) is always computed regardless of this setting.
Controls semantic clustering via the host's MCP sampling capability. off skips it and returns only the deterministic groupings. auto (default) attempts it and falls back to an ai_clustering_hint for the calling AI to apply inline if the host doesn't support sampling. on requires sampling support and returns a sampling_unsupported error if the host doesn't provide it.
Optional model preference hint for the sampling request. Currently accepted but not forwarded to the host's createMessage call (the sampling request always uses a fixed speed/intelligence preference); reserved for future use.
Server-side deterministic groupings (by selector / page / reviewer / keyword) plus heuristic suggested_clusters of change requests. Set ai_clusters="auto" (default) to also request semantic clustering via the host's MCP sampling capability — returns ai_clustering_hint for the host AI to apply inline if sampling is unsupported. Use this BEFORE drilling into individual CRs to find patterns across the dataset.
| Argument | Type | Description |
|---|---|---|
| include | array | Which feedback kinds to pull into the analysis: change_requested (a decision requesting a change), rejected (a decision rejecting the pick), approved (a decision approving the pick), comment (a comment-only pin, no decision). Defaults to ['change_requested']. |
| project* | string | The project slug. |
| group_by | array | Which deterministic groupings to compute: selector (by CSS selector), page (by page URL), reviewer (by reviewer). Defaults to ['selector', 'page']. Keyword extraction (common_keywords) is always computed regardless of this setting. |
| ai_clusters | string | Controls semantic clustering via the host's MCP sampling capability. off skips it and returns only the deterministic groupings. auto (default) attempts it and falls back to an ai_clustering_hint for the calling AI to apply inline if the host doesn't support sampling. on requires sampling support and returns a sampling_unsupported error if the host doesn't provide it. |
| ai_model_preference | string | Optional model preference hint for the sampling request. Currently accepted but not forwarded to the host's createMessage call (the sampling request always uses a fixed speed/intelligence preference); reserved for future use. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"include": {
"type": "array",
"items": {
"enum": [
"change_requested",
"rejected",
"approved",
"comment"
],
"type": "string"
},
"description": "Which feedback kinds to pull into the analysis: change_requested (a decision requesting a change), rejected (a decision rejecting the pick), approved (a decision approving the pick), comment (a comment-only pin, no decision). Defaults to ['change_requested']."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
},
"group_by": {
"type": "array",
"items": {
"enum": [
"selector",
"page",
"reviewer",
"keyword"
],
"type": "string"
},
"description": "Which deterministic groupings to compute: selector (by CSS selector), page (by page URL), reviewer (by reviewer). Defaults to ['selector', 'page']. Keyword extraction (common_keywords) is always computed regardless of this setting."
},
"ai_clusters": {
"enum": [
"off",
"auto",
"on"
],
"type": "string",
"description": "Controls semantic clustering via the host's MCP sampling capability. off skips it and returns only the deterministic groupings. auto (default) attempts it and falls back to an ai_clustering_hint for the calling AI to apply inline if the host doesn't support sampling. on requires sampling support and returns a sampling_unsupported error if the host doesn't provide it."
},
"ai_model_preference": {
"type": "string",
"description": "Optional model preference hint for the sampling request. Currently accepted but not forwarded to the host's createMessage call (the sampling request always uses a fixed speed/intelligence preference); reserved for future use."
}
},
"additionalProperties": false
}Soft-archive a project — the widget stops accepting new feedback but the project + history is preserved. Reversible via unarchive_project. Owner role required.
| Argument | Type | Description |
|---|---|---|
| project* | string | The project slug to archive. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug to archive."
}
},
"additionalProperties": false
}Create a new PinAppAI project inside the API key's workspace. Returns the project plus its widget api_key for embedding. Requires editor role on the workspace.
| Argument | Type | Description |
|---|---|---|
| name* | string | Human-readable project name. |
| slug* | string | Project slug (lowercase, hyphens). Must be unique across all PinAppAI projects. |
| allowed_origins | array | Origins where the widget will load (e.g. https://example.com or *.example.com). Up to 20 entries. |
{
"type": "object",
"required": [
"slug",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Human-readable project name."
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]*$",
"maxLength": 64,
"minLength": 2,
"description": "Project slug (lowercase, hyphens). Must be unique across all PinAppAI projects."
},
"allowed_origins": {
"type": "array",
"items": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"maxItems": 20,
"description": "Origins where the widget will load (e.g. https://example.com or *.example.com). Up to 20 entries."
}
},
"additionalProperties": false
}Create a new workspace owned by the API key's user. Free/Pro plans cap at 1 workspace; Team/Business unlimited. To use the new workspace from MCP, mint a fresh key for it in the admin UI.
| Argument | Type | Description |
|---|---|---|
| name* | string | Human-readable workspace name. |
| slug* | string | Workspace slug (lowercase, hyphens). Globally unique. |
{
"type": "object",
"required": [
"slug",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Human-readable workspace name."
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]*$",
"maxLength": 64,
"minLength": 2,
"description": "Workspace slug (lowercase, hyphens). Globally unique."
}
},
"additionalProperties": false
}Schedule the API key's workspace for permanent deletion (7-day grace window). Reversible only via the email magic-link sent to the owner. Subsequent MCP calls with this key will fail not_found until cancelled.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}GDPR Art. 15 right-of-access export — every row PinAppAI holds about the API key's user. Sensitive columns (password hash, OAuth tokens) are server-side redacted. Personal data of OTHER reviewers is NOT included.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Get a single API key's metadata by id (no plaintext / hash). Owner or admin role required. Wrong-role and nonexistent-id both surface as not_found.
| Argument | Type | Description |
|---|---|---|
| id* | string | The api_keys.id (from list_api_keys). |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The api_keys.id (from list_api_keys)."
}
},
"additionalProperties": false
}Full detail for one change request. Returns the CR (including element_kind=text|mixed|field|null and suggested_text — a literal text-replacement the reviewer typed when picking a text/field element), plus related[] (other CRs on the same selector + same page) so you can detect patterns from a single fetch. Set include_image=true to embed the screenshot inline as an MCP image content block. When suggested_text is non-null on a text/field pick, paste it verbatim — do not interpret or rewrite. When element_kind=mixed, the element contains more than text (icons/images/structure) — rely on the comment + screenshot, not just the visible text.
| Argument | Type | Description |
|---|---|---|
| id* | string | The FEEDBACK id (fb_*), NOT a change-request id (cr_*). When you have a CR row from pinappai_list_apply_inbox / list_change_requests, pass its `source_feedback_id` (or just `id` in list_change_requests' response — same field) here. Passing a cr_* value returns 404. |
| project* | string | The project slug. |
| include_image | boolean | When true, also returns the change request's screenshot inline as an MCP image content block, in addition to the JSON text response. Defaults to false (JSON only). |
{
"type": "object",
"required": [
"project",
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The FEEDBACK id (fb_*), NOT a change-request id (cr_*). When you have a CR row from pinappai_list_apply_inbox / list_change_requests, pass its `source_feedback_id` (or just `id` in list_change_requests' response — same field) here. Passing a cr_* value returns 404."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
},
"include_image": {
"type": "boolean",
"description": "When true, also returns the change request's screenshot inline as an MCP image content block, in addition to the JSON text response. Defaults to false (JSON only)."
}
},
"additionalProperties": false
}Whoami probe — returns the user behind the API key, the workspace it's bound to, the user's role in that workspace, and the API key's metadata. Run this first to establish context.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Get a single project by slug — name, allowed_origins, archive state, and the embeddable widget api_key. Scoped to the API key's workspace.
| Argument | Type | Description |
|---|---|---|
| project* | string | The project slug. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
}
},
"additionalProperties": false
}Cheap one-call summary of change-request state for a project. Returns totals + by-page + by-reviewer breakdowns + oldest/newest unresolved timestamps. Call this BEFORE drilling into individual CRs to frame the work.
| Argument | Type | Description |
|---|---|---|
| project* | string | The project slug. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
}
},
"additionalProperties": false
}Return the screenshot for a change request as an inline MCP image content block. Use when you want vision context without the full JSON envelope from get_change_request.
| Argument | Type | Description |
|---|---|---|
| id* | string | The FEEDBACK id (fb_*), NOT a change-request id (cr_*). When you have a CR row from pinappai_list_apply_inbox, pass its `source_feedback_id` here. Passing a cr_* value returns 404. |
| project* | string | The project slug. |
{
"type": "object",
"required": [
"project",
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The FEEDBACK id (fb_*), NOT a change-request id (cr_*). When you have a CR row from pinappai_list_apply_inbox, pass its `source_feedback_id` here. Passing a cr_* value returns 404."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
}
},
"additionalProperties": false
}Get the API key's workspace details (slug, name, plan, tier) plus the user's role in that workspace. Useful as a permissions probe.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Invite a user to the API key's workspace as admin / editor / viewer (default editor). Admin role required to call. Sends a welcome email.
| Argument | Type | Description |
|---|---|---|
| name | string | Optional display name; defaults to the email's local-part. |
| role | string | Defaults to editor. Admins can't invite owners — that requires an existing owner. |
| email* | string | Invitee's email address. |
{
"type": "object",
"required": [
"email"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"description": "Optional display name; defaults to the email's local-part."
},
"role": {
"enum": [
"admin",
"editor",
"viewer"
],
"type": "string",
"description": "Defaults to editor. Admins can't invite owners — that requires an existing owner."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "Invitee's email address."
}
},
"additionalProperties": false
}Invite an external reviewer to a project. They'll get a welcome email; status starts pending and flips to verified when they OTP through the widget. Editor role required.
| Argument | Type | Description |
|---|---|---|
| name | string | Optional display name; defaults to the email's local-part. |
| email* | string | Reviewer's email address. |
| project* | string | The project slug. |
{
"type": "object",
"required": [
"project",
"email"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"description": "Optional display name; defaults to the email's local-part."
},
"email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "Reviewer's email address."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
}
},
"additionalProperties": false
}List API keys (active + recently-revoked) in the calling key's workspace. Plaintext / hash never returned. Owner or admin role required.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Read audit log entries for the API key's workspace. Owner role + Business tier required. Returns newest-first; supports filters action / actor (email substring) / from / to (Unix ms).
| Argument | Type | Description |
|---|---|---|
| to | integer | End of time range (Unix ms, exclusive). |
| from | integer | Start of time range (Unix ms, inclusive). |
| actor | string | Substring match on actor_email. |
| limit | integer | Default 100, max 500. |
| action | string | Exact dotted action name (e.g. "feedback.update", "member.invite"). |
| offset | integer | Default 0. |
{
"type": "object",
"properties": {
"to": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "End of time range (Unix ms, exclusive)."
},
"from": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Start of time range (Unix ms, inclusive)."
},
"actor": {
"type": "string",
"description": "Substring match on actor_email."
},
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Default 100, max 500."
},
"action": {
"type": "string",
"description": "Exact dotted action name (e.g. \"feedback.update\", \"member.invite\")."
},
"offset": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0,
"description": "Default 0."
}
},
"additionalProperties": false
}List change requests for a project with filters + cursor pagination. Defaults to include=['change_requested'] (highest-signal subset). Returns digest fields per row (including element_kind=text|mixed|field|null and suggested_text — a literal text replacement on text/field picks); no inline images at this tier (token-cheap by design). Use get_change_request for full detail + screenshots.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max rows to return per page. Defaults to 50, maximum 200. |
| since | string | ISO 8601 timestamp. Only return change requests created after this time. |
| cursor | string | Opaque pagination cursor from a previous response's next_cursor. Pass it to fetch the next page. |
| include | array | Which feedback kinds to include: change_requested (a decision requesting a change), rejected (a decision rejecting the pick), approved (a decision approving the pick), comment (a comment-only pin, no decision). Defaults to ['change_requested']. |
| project* | string | The project slug. |
| page_url | string | Filter to change requests captured on this exact page URL. |
| reviewer | string |
List members of the API key's workspace with their roles, sorted owner → admin → editor → viewer. The user_id field is the lookup key for update_member_role and remove_member.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}List PinAppAI projects this API key can access. Returns one entry per project in the key's workspace, with slug, name, derived domain, and created_at. Call this first to see what projects are available before drilling into specific ones.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}List external reviewers on a project (people invited via invite_reviewer). Workspace members are implicitly authorized and not listed here. Status: pending / verified / revoked.
| Argument | Type | Description |
|---|---|---|
| project* | string | The project slug. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
}
},
"additionalProperties": false
}List all workspaces the API key's user is a member of, with role per workspace. The api-key remains bound to its original workspace — to operate on another, mint a new key for that workspace in the admin UI.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}v3 atomic apply primitive. Takes a list of {cr_id, before_text, after_text} after the AI has edited source for each. Creates one iteration record (audit trail visible in the Project history page) and transitions every eligible CR from inbox_* state to 'in_review' atomically. Per-CR errors (CR not in eligible state, e.g. someone deferred it mid-session) are returned in the response without failing the whole batch. Editor role required.
| Argument | Type | Description |
|---|---|---|
| applies* | array | List of CRs to mark applied in one atomic batch. |
| project* | string | The project slug. |
| bundle_summary | string | Short human-readable summary of this Apply batch — shows up in the project history page. e.g. "applied 7 CRs across 3 pages". |
{
"type": "object",
"required": [
"project",
"applies"
],
"properties": {
"applies": {
"type": "array",
"items": {
"type": "object",
"required": [
"cr_id",
"before_text",
"after_text"
],
"properties": {
"cr_id": {
"type": "string",
"minLength": 1,
"description": "The change-request id (cr_*)."
},
"after_text": {
"type": "string",
"maxLength": 4000,
"description": "The source-file content AFTER your edit."
},
"before_text": {
"type": "string",
"maxLength": 4000,
"description": "The source-file content this CR targeted BEFORE you edited it. Stored on the cr_marked_applied event payload so admin Revert can swap byte-for-byte later. For 'inbox_rejected' CRs the AI should have already done the swap (after_text → before_text from the CR's previous cr_marked_applied event); the new before_text is the pre-revert source and after_text is the post-revert source."
}
},
"additionalProperties": false
},
"minItems": 1,
"description": "List of CRs to mark applied in one atomic batch."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
},
"bundle_summary": {
"type": "string",
"maxLength": 2000,
"description": "Short human-readable summary of this Apply batch — shows up in the project history page. e.g. \"applied 7 CRs across 3 pages\"."
}
},
"additionalProperties": false
}Read coverage metrics for an iteration: items_decided / manifest_size + items_undecided + per-reviewer decided_count + disagreement_count. Useful for the AI to summarize "you have N items still waiting on M reviewers" and identify CRs needing admin attention. Read-only.
| Argument | Type | Description |
|---|---|---|
| project* | string | The project slug. |
| iteration_id* | string | The iteration id (it_*). |
{
"type": "object",
"required": [
"project",
"iteration_id"
],
"properties": {
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
},
"iteration_id": {
"type": "string",
"minLength": 1,
"description": "The iteration id (it_*)."
}
},
"additionalProperties": false
}Return the full procedure for a PinAppAI guided workflow, rendered exactly as the /pinappai:<name> prompt delivers it. Call this when the user asks for one of these and this client does not surface MCP prompts. Follow the returned text verbatim and do not improvise a workflow from its name or description. Available workflows: analyze Read-only pattern analysis of change requests apply v3 PinAppAI Apply — drain the project Inbox by editing source for every Apply-eligible change… audit-review Pull recent audit-log events for the workspace and summarize unusual activity auth-help Walk through PinAppAI MCP authentication — recommend the browser-flow login first, fall back… embed-widget Embed the PinAppAI widget snippet into an EXISTING project's site, then bootstrap the… generate-changes-page Generate a temporary /changes/ review page for a multi-page rewrite remove Remove ALL PinAppAI integration from this repository (widget script, /changes/ pages, optional… reset-project Reset a project's review data to zero — permanently delete its change requests, iterations,… setup-project Walk the user through creating a new PinAppAI project from scratch — pick or create a… summarize Generate a PR description / changelog / customer email from completed work, referencing the…
| Argument | Type | Description |
|---|---|---|
| name* | string | The workflow to fetch. See the description for what each does. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"enum": [
"analyze",
"apply",
"audit-review",
"auth-help",
"embed-widget",
"generate-changes-page",
"remove",
"reset-project",
"setup-project",
"summarize"
],
"type": "string",
"description": "The workflow to fetch. See the description for what each does."
}
},
"additionalProperties": false
}v3 Apply-inbox listing. Returns every change request in an Apply-eligible inbox substate (inbox_new / inbox_rejected / inbox_change_requested) with the prior cr_marked_applied event payload AND the latest reviewer/admin decision payload inlined per row. Used by /pinappai:apply to drive substate-specific edits (new = standard apply; rejected = revert via swap; change_requested = apply with new wording) in one round-trip.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max rows to return (default 100). |
| project* | string | The project slug. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "Max rows to return (default 100)."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
}
},
"additionalProperties": false
}Paginated history of iterations for a project, newest first. Each entry includes seq_no, opened_at, applied_at (NULL while open), bundle_summary, and the frozen manifest_cr_ids_json + manifest_reviewer_ids_json. Pair with pinappai_get_iteration_coverage to summarize outcomes per iteration.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Max iterations to return (default 50, max 200). |
| project* | string | The project slug. |
| before_seq | integer | Pagination cursor — return iterations with seq_no strictly less than this. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Max iterations to return (default 50, max 200)."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
},
"before_seq": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Pagination cursor — return iterations with seq_no strictly less than this."
}
},
"additionalProperties": false
}Register the items of a freshly written /changes/ review page with the server — REQUIRED after generating or regenerating the page, or the in-page review chip and decision bars have no data. Pass every [data-pp-item] in document order with the same attribute values you put in the markup. This replaces the removed client-side self-registration: the page itself can no longer register anything. Editor role required.
| Argument | Type | Description |
|---|---|---|
| items* | array | Every [data-pp-item] on the page you just wrote, in DOCUMENT ORDER (order drives the review queue). The FULL active set — items you omit are deactivated server-side. |
| project* | string | The project slug. |
| page_path | string | Path of the /changes/ page on the site. Default '/changes'. |
{
"type": "object",
"required": [
"project",
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The data-pp-item value — e.g. \"pricing:hero-title\"."
},
"title": {
"type": "string",
"maxLength": 300,
"description": "The data-pp-title value."
},
"after_text": {
"type": "string",
"maxLength": 4000,
"description": "The AFTER text, verbatim from the page."
},
"before_text": {
"type": "string",
"maxLength": 4000,
"description": "The BEFORE text, verbatim from the page."
},
"applied_cr_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The originating CR id (data-pp-applied-cr-id). Items whose CR no longer exists are dropped server-side; omit only for hand-authored items."
},
"target_page_url": {
"type": "string",
"maxLength": 2048,
"description": "Root-relative URL of the ACTUAL page the change lives on (data-pp-page-url)."
},
"target_source_files": {
"type": "string",
"maxLength": 2048,
"description": "Comma-separated source-repo file paths (data-pp-source-files)."
},
"target_source_selector": {
"type": "string",
"maxLength": 2048,
"description": "CSS selector to the element on the source page (data-pp-source-selector)."
}
},
"additionalProperties": false
},
"maxItems": 2000,
"minItems": 1,
"description": "Every [data-pp-item] on the page you just wrote, in DOCUMENT ORDER (order drives the review queue). The FULL active set — items you omit are deactivated server-side."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
},
"page_path": {
"type": "string",
"pattern": "^\\/[\\w\\-./]*$",
"maxLength": 2048,
"minLength": 1,
"description": "Path of the /changes/ page on the site. Default '/changes'."
}
},
"additionalProperties": false
}Permanently deletes a project's review data: all change requests (+ their event history), iterations, reviewer decisions, ALL freeform pins/comments with their screenshots, and the /changes/-page registration tables. NOT recoverable — no grace window. Requires admin role. Ask the user for explicit confirmation before calling, and prefer the /pinappai:reset-project prompt, which also offers to clean up the repo's static /changes/ page and .pinappai/last-applied.json.
| Argument | Type | Description |
|---|---|---|
| confirm* | boolean | Must be literally true. The caller must have shown the user what will be deleted and received explicit confirmation first — there is no grace window; this is not recoverable. |
| project* | string | The project slug. |
{
"type": "object",
"required": [
"project",
"confirm"
],
"properties": {
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be literally true. The caller must have shown the user what will be deleted and received explicit confirmation first — there is no grace window; this is not recoverable."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
}
},
"additionalProperties": false
}Remove a member from the API key's workspace. Self-removal works for any role; cross-removal requires admin+ and outranking the target. Last-owner removal returns last_owner.
| Argument | Type | Description |
|---|---|---|
| user_id* | string | The member's user_id (from list_members). |
{
"type": "object",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"description": "The member's user_id (from list_members)."
}
},
"additionalProperties": false
}Restore a soft-revoked API key (within 7 days of revocation). Owner or admin role required. Returns restore_window_expired if the row was never revoked or was revoked > 7 days ago.
| Argument | Type | Description |
|---|---|---|
| id* | string | The api_keys.id to restore. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The api_keys.id to restore."
}
},
"additionalProperties": false
}Soft-revoke an API key (reversible via restore_api_key for 7 days). Owner or admin role required. Refuses to revoke the calling key with cannot_revoke_self.
| Argument | Type | Description |
|---|---|---|
| id* | string | The api_keys.id to revoke. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "The api_keys.id to revoke."
}
},
"additionalProperties": false
}Revoke an external reviewer's access. First call soft-revokes (status=revoked, audit trail preserved); second call hard-deletes (status=removed). Editor role required.
| Argument | Type | Description |
|---|---|---|
| project* | string | The project slug. |
| reviewer_id* | string | The project_reviewers row id (from list_reviewers). |
{
"type": "object",
"required": [
"project",
"reviewer_id"
],
"properties": {
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
},
"reviewer_id": {
"type": "string",
"minLength": 1,
"description": "The project_reviewers row id (from list_reviewers)."
}
},
"additionalProperties": false
}Restore an archived project — the widget starts accepting feedback again on pages that still embed the snippet. Owner role required.
| Argument | Type | Description |
|---|---|---|
| project* | string | The project slug to unarchive. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug to unarchive."
}
},
"additionalProperties": false
}Update the API key user's display name. Email is identity and not editable.
| Argument | Type | Description |
|---|---|---|
| name* | string | The new display name. |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "The new display name."
}
},
"additionalProperties": false
}Change a workspace member's role. Caller must outrank both the current role and the new role; promoting to owner requires owner role. Last-owner demotion is rejected with last_owner.
| Argument | Type | Description |
|---|---|---|
| role* | string | The new role. |
| user_id* | string | The member's user_id (from list_members). |
{
"type": "object",
"required": [
"user_id",
"role"
],
"properties": {
"role": {
"enum": [
"owner",
"admin",
"editor",
"viewer"
],
"type": "string",
"description": "The new role."
},
"user_id": {
"type": "string",
"minLength": 1,
"description": "The member's user_id (from list_members)."
}
},
"additionalProperties": false
}Update editable fields on a project — slug, name, owner_email, allowed_origins, allow_anonymous_reviewers, primary_origin (review link), preview_origin (preview review link). Requires editor role.
| Argument | Type | Description |
|---|---|---|
| name | string | New display name for the project. |
| slug | string | New slug (renames the project; widget snippets keep working since they reference api_key, not slug). |
| project* | string | Current project slug (the lookup key). |
| owner_email | string | Reassign project ownership to a different email (for display only — does not change permissions). |
| preview_origin | any | Optional branch/preview deploy origin. review.pinappai.com/p/<slug>~preview/ serves it so reviewers can check APPLIED changes before they ship — records still write against primary_origin. Set this after publishing an apply round to a preview deploy; null (or an empty string) clears it. |
| primary_origin | any | Canonical site origin powering the no-install review link (review.pinappai.com/p/<slug>/). Any URL is normalized down to its origin. null (or an empty string) clears it and disables the link. |
| allowed_origins | array | REPLACES the existing list. Pass an empty array [] to clear all allowed origins. |
Rename or re-slug the API key's workspace. Owner role required. Slug changes break existing dashboard URLs.
| Argument | Type | Description |
|---|---|---|
| name | string | New display name for the workspace. |
| slug | string | Renaming slug breaks every URL pointing at the old slug — use sparingly. |
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "New display name for the workspace."
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]*$",
"maxLength": 64,
"minLength": 2,
"description": "Renaming slug breaks every URL pointing at the old slug — use sparingly."
}
},
"additionalProperties": false
}| Filter by reviewer name or email (matches either field). |
{
"type": "object",
"required": [
"project"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Max rows to return per page. Defaults to 50, maximum 200."
},
"since": {
"type": "string",
"description": "ISO 8601 timestamp. Only return change requests created after this time."
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor from a previous response's next_cursor. Pass it to fetch the next page."
},
"include": {
"type": "array",
"items": {
"enum": [
"change_requested",
"rejected",
"approved",
"comment"
],
"type": "string"
},
"description": "Which feedback kinds to include: change_requested (a decision requesting a change), rejected (a decision rejecting the pick), approved (a decision approving the pick), comment (a comment-only pin, no decision). Defaults to ['change_requested']."
},
"project": {
"type": "string",
"minLength": 1,
"description": "The project slug."
},
"page_url": {
"type": "string",
"description": "Filter to change requests captured on this exact page URL."
},
"reviewer": {
"type": "string",
"description": "Filter by reviewer name or email (matches either field)."
}
},
"additionalProperties": false
}| allow_anonymous_reviewers | boolean | When true, any verified email on a CORS-allowed origin can submit feedback. When false, the email must be on the workspace or project_reviewers list. |
{
"type": "object",
"required": [
"project"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "New display name for the project."
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9][a-z0-9-]*$",
"maxLength": 64,
"minLength": 2,
"description": "New slug (renames the project; widget snippets keep working since they reference api_key, not slug)."
},
"project": {
"type": "string",
"minLength": 1,
"description": "Current project slug (the lookup key)."
},
"owner_email": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"maxLength": 254,
"description": "Reassign project ownership to a different email (for display only — does not change permissions)."
},
"preview_origin": {
"anyOf": [
{
"type": "string",
"format": "uri",
"maxLength": 255
},
{
"type": "null"
}
],
"description": "Optional branch/preview deploy origin. review.pinappai.com/p/<slug>~preview/ serves it so reviewers can check APPLIED changes before they ship — records still write against primary_origin. Set this after publishing an apply round to a preview deploy; null (or an empty string) clears it."
},
"primary_origin": {
"anyOf": [
{
"type": "string",
"format": "uri",
"maxLength": 255
},
{
"type": "null"
}
],
"description": "Canonical site origin powering the no-install review link (review.pinappai.com/p/<slug>/). Any URL is normalized down to its origin. null (or an empty string) clears it and disables the link."
},
"allowed_origins": {
"type": "array",
"items": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"maxItems": 20,
"description": "REPLACES the existing list. Pass an empty array [] to clear all allowed origins."
},
"allow_anonymous_reviewers": {
"type": "boolean",
"description": "When true, any verified email on a CORS-allowed origin can submit feedback. When false, the email must be on the workspace or project_reviewers list."
}
},
"additionalProperties": false
}