Integrations

MCP tools and prompts

Reference for reading documentation, reviewing Inbox items, drafting changes, and following runs through Pageloop MCP.

MCP tools and prompts

Pageloop's Model Context Protocol (MCP) server at https://mcp.pageloop.ai/mcp lets your connected assistant read documentation, review Inbox items, draft changes, run the docs agent, and manage workspace workflows and settings. Connect through Pageloop sign-in and consent; no API tokens are used. Prompts provide reusable instructions for common tasks. The tables below group tools by task.

Drafting does not update your published documentation. Writes to pages, navigation, and site settings stay in a change set. Submitting a change set opens or updates a pull request; merging that pull request is a separate publishing action that requires Publish live. Workspace-management tools, such as workflow, team, screenshot-login, template, and AI-style changes, take effect directly rather than creating change-set drafts.

Availability and input conventions

Your connection's permissions determine which tools and prompts your MCP client lists. Use server_info and list_sites to check your access and discover IDs rather than guessing them. If a capability is missing, reconnect Pageloop and choose Full access, or choose Custom and select the relevant permissions; your role determines what is offered.

  • Change sets apply to Pageloop-hosted documentation sites. Use container: { "kind": "docs_site", "id": "…" } where a tool takes a container.
  • Page paths are repository-relative, without a leading slash or file extension, such as guides/setup.
  • version is a version slug; version_id is a version ID. Omitting either uses the site's default version where supported.
  • Authoring access in the tables means at least one of Draft changes, Review proposals, Submit for review, or Publish live on the same site. Reading change-set drafts requires Read pages as well. These permissions are granted separately; none implies another.
  • Editors and Admins can create change sets, draft pages, submit, and merge. Contributors review Inbox items assigned to them and hand work back for publishing; they cannot reassign items.

See The Pageloop sidebar for the corresponding areas in the app.

Permission names below match the sign-in consent screen. A tool being listed does not grant access to every site: each call checks the selected site or item. Workspace-level tools act on the workspace you authorized.

Discover sites and read documentation

These tools are read-only.

ToolPurposeKey inputsReturnsPermission
server_infoCheck the connection and its permissions.None.Server version, workspace, acting user and role, granted containers and scopes, and applicable limits.Any granted permission
list_sitesFind the sites your connection can access.None.Site IDs, names, URLs, scopes, and indicators of whether content and suggestions are readable.Any granted permission
get_org_contextRead the workspace's writing standards before drafting or auditing.site_id when you can read more than one site.Product description, tone, product terms, allowed MDX components, path examples, and workflow guidance.Read pages
list_pagesFind published pages and their paths.site_id; optional version.Published navigation, page IDs, paths, titles, descriptions, URLs, and the selected version.Read pages
searchSearch published documentation across granted sites.query.results with document IDs, titles, URLs, and snippets.Search
fetchRetrieve a published document found by search.id from a search result.Document ID, title, full text, and URL.Read pages
search_docsFind documentation about a subject.query; optional site_id, limit.Matching pages with snippets and a draft indicator; includes_drafts reports whether your permissions allowed unpublished editor working copies. Does not search change-set drafts.Search
get_pageRead one published page's source.site_id, path; optional version.MDX, frontmatter, title, description, URL, page_hash, and whether the page is generated.Read pages
get_page_draftRead a page draft in a change set.change_set_id, path.Draft MDX, metadata, status, and base_hash for a concurrency-checked write.Read pages + authoring access

search and fetch provide the published-document search and retrieval contract used by deep-research clients. Use get_page_draft to read drafts written through MCP rather than searching for those drafts.

If get_page_draft returns draft_not_found, the change set has no live draft at that path. Read the published page with get_page instead. Generated API reference pages cannot be drafted through these tools.

Find and collaborate on Inbox items

An Inbox item's job_id identifies the item, not its change set. One item can contain multiple change sets or pause on questions before it has a proposal.

ToolPurposeKey inputsReturnsPermission
list_inbox_itemsFind proposals waiting for review.Optional status: open (default), assigned_to_you, ready_for_publish, resolved, or any; limit, cursor.Items newest first, ownership, undecided-change and question counts, run and change-set IDs, inbox_url, and pagination.Read pages
get_inbox_itemOpen an item from its link or ID.Exactly one of link or job_id.Change sets and entry counts, review state and review tokens, assignee, run information, and inbox_url.Read pages
get_capture_failuresFind why screenshots are missing from an item.Exactly one of link or job_id; a run ID can identify work with no Inbox item yet.In-progress or run-failure indicators, capture failures, who can fix them, suggested fixes and paths, and can_fix_logins.Read pages
list_inbox_commentsRead an item's discussion before adding a comment.job_id; optional limit, cursor.Comments oldest first, authors, targets, reply relationships, pagination, and inbox_url.Review proposals
comment_on_inbox_itemAdd context, explain a decision, or reply.body and exactly one of job_id, entry_id, or parent_comment_id.Comment ID, target, parent comment ID, creation time, and inbox_url.Review proposals
assign_inbox_itemSet who owns an item.job_id, assignee_id: a user ID, "me", or null to unassign.Assignee ID, assigned_to_you, whether the assignment changed, review state, and inbox_url.Review proposals
mark_ready_for_publishHand reviewed work back to an Editor or Admin.job_id; optional note, recipient_id (defaults to whoever assigned the item).review_state: ready_for_publish, whether the hand-off changed the item, whether a note was posted, and inbox_url.Review proposals

Pass a listing's next_cursor back as cursor to read the next page. Assignee details require review permission; assignee: null alone does not prove an item is unassigned.

Commenting changes no documentation and decides nothing. Assigning another person emails them when the assignment changes. Marking work ready for publishing reassigns and notifies the recipient but publishes nothing.

Inspect and decide proposed changes

ToolPurposeKey inputsReturnsPermission
list_change_set_entriesInspect the proposal's page and structural changes.change_set_id; optional status, path, limit.Entries with IDs, kinds, decisions, explanations, exact updated_at tokens, whole-proposal counts, review, and truncated.Read pages + authoring access
list_suggestionsRead tracked passages proposed within page edits.change_set_id or container; optional path, status, limit. Defaults to pending suggestions.Suggestions with proposed text, decisions, explanations, owning entry IDs and statuses, and exact updated_at tokens.Read suggestions
get_suggestionRead one suggestion and its evidence in full.id from list_suggestions.Proposed additions and removals, explanation, severity, target and review state, and quoted source or cited evidence.Read suggestions
decide_change_set_entryAccept, reject, or undo a decision on one entry.entry_id, status: accepted, rejected, or pending; review tokens as described below.Entry and change-set IDs, resulting status, updated_at, and the next review_generation when applicable.Review proposals
decide_tracked_changeApprove, reject, or undo one tracked passage.change_id from list_suggestions, status: approved, rejected, or pending; review tokens as described below.Change and change-set IDs, resulting status, updated_at, and the next review_generation when applicable.Review proposals
decide_change_set_entriesDecide all pending tracked changes on one page.scope: "page", page-edit entry_id, status: accepted or rejected; review_id and review_generation when the proposal has a review block.Resulting status, updated_count, updated_at, and the next review_generation when applicable.Review proposals
refine_change_setAsk Pageloop to rework an agent proposal.change_set_id, instructions; review_id and review_generation when a review block exists; optional idempotency_key.A run_id to follow with get_run_status.Review proposals

Decide only the changes the person asked you to decide. Publishing includes accepted entries only; a tracked passage must also be approved to appear in an accepted page edit.

For proposals with a review block:

  • Pass review_id on each decision. For a single entry or tracked change, also pass its listed updated_at as expected_updated_at, preserving all six fractional digits and an entry's null value when returned.
  • For a page-wide decision, pass review_generation. Each decision advances the generation; use the returned value or read the proposal again.
  • Wait while review.run_active is true or review.writable is false.
  • After a refinement finishes, list entries and suggestions again: their IDs are replaced.

Create and edit a change set

ToolPurposeKey inputsReturnsPermission
list_change_setsFind existing change sets for a site.container; optional version_id, status: open (default), merged, closed, or all.Change sets with status, source, drafts_writable, pull request details, and Git state.Read pages
create_change_setOpen a draft workspace for a piece of work.container, name unique among the version's open change sets; optional version_id.Change-set ID, name, slug, status, version ID, and materialized: false.Draft changes
get_change_setInspect draft metadata and submission progress.change_set_id.Page statuses and baseline-drift indicators, drafts_writable, Git state, pull request details, and agent review and submission blocks when applicable. No page bodies.Read pages + authoring access
validate_mdxCheck content without saving it.mdx; optional title, description, path.valid, diagnostics, and whether validation is enforced.Read pages
upsert_page_draftCreate or replace one page draft.change_set_id, path, complete mdx; title for a new page; optional description, base_hash, page_hash, upstream_hash.Draft ID, status, base_hash, whether content was unchanged, warnings, and materialized: false.Draft changes
upsert_page_draftsWrite multiple page drafts in one call.change_set_id, pages containing the same page fields as upsert_page_draft.Per-page successes or failures, totals, warnings, and materialized: false.Draft changes

Read the current page or draft before writing: page writes replace the whole document. Pass page_hash when drafting from a published page and base_hash when revising a draft to detect concurrent changes. The batch tool checks each page independently; one failed page does not discard successful pages. server_info reports the batch limit.

An agent's Inbox proposal is reviewed through decisions rather than overwritten with page drafts. Use an open change set whose drafts_writable is true for direct drafting. Creating a page does not add it to navigation.

Preview, sync, and resolve drift

ToolPurposeKey inputsReturnsPermission
preview_change_setOpen the rendered site with a change set applied.change_set_id.Preview ID, url, changed_page_url, status, and whether the preview was reused.Read pages + authoring access
sync_change_setBring draft content up to date with repository changes, or refresh an agent proposal's review from its branch.change_set_id.For drafts: sync summary, absorbed changes, drifted pages with offered actions and hashes, conflicts, and editor URLs. For agent proposals: status: queued and import details.Draft changes for drafts; Review proposals for agent proposals
resolve_driftApply the person's chosen action to one drifted draft page.change_set_id, path, action, draft_hash, upstream_hash from sync; new_path where applicable.Applied result, resulting path, and editor URL.Draft changes

A preview publishes nothing. A first preview can take a minute or two to become reachable while its certificate is issued.

Syncing writes no Git commit or pull request. For a draft change set, apply only actions that sync_change_set offers: bring_in, take_upstream, sync_delete, revert_delete, or keep_at_new_path. Draft sync and drift resolution require an Editor or Admin. Overlapping changes need a person to resolve them at editor_url; do not report the sync as finished while conflicts remain. Agent proposals are refreshed as a whole: read entries and suggestions again after the queued import, rather than calling resolve_drift on their pages.

Page writes also check for repository drift. A draft_rebased warning means non-overlapping changes were merged into the draft; read the draft again before editing. A draft_drifted refusal with resolvable_by: writer supplies upstream_mdx and upstream_hash: redo the edit on that text and pass the hash. If resolvable_by is person, stop and ask the person to resolve the change in Pageloop.

Edit navigation and site settings

These tools appear only when navigation and site-settings editing is enabled for your connection's server. Navigation and site-settings edits require an Editor or Admin. Theme changes require an Admin; Editors can change redirects. All edits below remain proposals in a change set.

ToolPurposeKey inputsReturnsPermission
get_navigation_draftRead the navigation that a change set will publish.site_id; optional change_set_id, version_id, under to narrow the outline.Ordered tabs, groups, and pages, truncated, and a base_hash for a change-set read. Without change_set_id, returns published navigation with no usable write hash.Read pages; authoring access for drafts
edit_navigationPropose navigation operations together.change_set_id, base_hash from the preceding read, operations; optional confirm.Applied changes, summary, and a replacement base_hash, or status: requires_confirmation with a plan.Draft changes
get_site_config_draftRead site settings as a change set will publish them.site_id; optional change_set_id, version_id.Theme, site block, manual redirects, and a base_hash for a change-set read; without a change set, returns published settings without a write hash.Read pages; authoring access for drafts
edit_site_configPropose theme or redirect changes together.change_set_id, base_hash, operations: set_theme, upsert_redirect, or remove_redirect; optional confirm.Changes, summary, and a replacement base_hash, or status: requires_confirmation with a plan.Draft changes

Navigation operations can create, rename, move, reorder, or delete groups; manage tabs, icons, landing pages, and navigation labels; and place or unlist pages. Use place_page to list a drafted page. Deleting a group requires it to be empty.

A set_theme operation changes one of colors, logo, favicon, fonts, or appearance. Site settings apply across all versions. Both edit tools apply the operations together or not at all. If a tool returns requires_confirmation, show the plan to the person and repeat the same plan with confirm: true only after approval.

Start and follow docs-agent runs

ToolPurposeKey inputsReturnsPermission
run_docs_agentAsk Pageloop's docs agent to research and draft documentation.text_input; optional release_title, template_id, run_id (UUID for safe retries).run_id, status, whether this replays a prior start, and poll_after_seconds.Run the docs agent
list_runsFind workspace runs or recover a run ID.Optional status: working, done, or any (default); limit, cursor.Runs newest first, titles, status, done, timestamps, ownership and Inbox links, and next_cursor.Run the docs agent or Review proposals
get_run_statusFollow a docs-agent run and read any questions.run_id.Status, done, phase, result summary, questions and question-round details, proposal IDs and links, updated change sets, and poll_after_seconds.Run the docs agent or Review proposals
answer_run_questionsSave the person's answers and resume a paused run.run_id, answers: each has question_id, selected_option_ids, and optional custom_text.Run status and polling interval, or status: superseded with new_run_id to follow.Run the docs agent or Review proposals

Starting a run requires an Editor or Admin. The agent chooses which documentation site to update in the workspace; run_docs_agent does not take a site ID. Use list_templates to find a template_id and server_info to check run limits. Pass a generated UUID as run_id and reuse it when retrying a start so a lost response does not start duplicate work. Runs create proposals, not published changes.

Wait at least poll_after_seconds between status checks. When done is true, stop polling even if no proposal was produced. When the status is needs_input, show the questions to the person rather than guessing answers.

Answer all unanswered questions in the round together, using the option IDs returned by get_run_status. Follow each question's type and allows_text setting. Questions whose options have a key use 1-based option IDs. Questions already answered can be omitted to keep their answers; sending a question replaces Pageloop's answer to it. Wait when a question is not answerable because another run is finishing the work. Older rounds allow custom text only with the Other option. After submitting answers, keep polling; if the result is superseded, follow new_run_id. Runs that write to a connected help center are answered in Pageloop rather than through MCP.

Submit and publish

Submitting requires Submit for review; merging requires Publish live. Both require an Editor or Admin role. Publishing permission is granted at consent, not through a separate approval for each use. Call submission only when asked to submit, open a pull request, or publish; call merge only when explicitly asked to merge or publish live.

ToolPurposeKey inputsReturnsPermission
submit_change_setCommit the proposal to its branch and open or update its pull request.change_set_id; for an agent proposal, review_id and review_generation from the latest review block.Draft submissions return pull request, commit, and file details; agent proposals can return preparing_submission, an operation ID, and poll_after_seconds. Nothing is live.Submit for review
merge_change_setMerge a submitted change set's pull request.change_set_id.Merge status and pull request details; pages become live after the site rebuilds.Publish live

For an agent proposal, poll get_change_set after submission until submission.status is completed and review.review_phase is awaiting_merge. If decisions change after submission, the proposal must be submitted again before merging. Report conflicts, failing checks, or other refusals rather than bypassing them.

Read and manage workflows

Any workspace member with Read workflows can read workflows. Creating, editing, activating, pausing, duplicating, and testing require an Editor or Admin with Manage workflows. Testing also requires Run the docs agent. Workflows run in workspaces whose knowledge base Pageloop hosts.

ToolPurposeKey inputsReturnsPermission
list_workflowsFind workflows and what needs attention.Optional group: attention, live, paused, or draft.Workflow IDs, names, status, trigger summaries, attention details, last real run, and next due time.Read workflows
read_workflowInspect one workflow before editing it.id.Trigger, steps, current version number and ID, authorship, status, and 20 most recent runs.Read workflows
list_workflow_runsFind runs across workflows or for one workflow.Optional workflow_id, status, mode, since (ISO time), limit, cursor.Runs newest first and pagination.Read workflows
read_workflow_runInspect what a workflow run read and produced.workflow_id, run_id.Run details, sources and drafted pages where accessible, Inbox or Slack output, and skip or failure reason.Read workflows
read_workflow_versionsCompare saved workflow versions.id; optional from, to (version numbers; defaults to previous and current).Before-and-after triggers, a line diff of steps, authors, and save times.Read workflows
create_workflowSave a workflow as a draft without turning it on.Optional name, steps, trigger, timezone.Workflow ID, name, status, current version and ID, next due time, and URL.Manage workflows
update_workflowChange a workflow's name, steps, or trigger.id, base_version_id from read_workflow; optional name, steps, trigger.Updated workflow metadata, current version ID, and URL.Manage workflows
activate_workflowTurn on a draft or paused workflow.id; backlog: "process" or "skip" when a merged-pull-request workflow needs a backlog choice.Workflow status, version, next due time, and URL.Manage workflows
pause_workflowStop a live workflow from running until reactivated.id.Paused workflow and URL.Manage workflows
duplicate_workflowCopy steps and trigger into a separate draft.id of the source workflow.The copy's metadata and URL; no runs are copied and it is not activated.Manage workflows
test_workflowRun the current saved version once as a test.id.Outcome, workflow run ID and status, and URL; follow with read_workflow_run.Manage workflows + Run the docs agent

steps accepts plain text with one step per line or the editor's document object. On updates, preserve mentions exactly as read_workflow returns them. trigger describes a schedule, published-article event, stale-pages scan, or merged-pull-request event where available. Invalid definitions return workflow_invalid with the fields to fix.

These tools change workflow configuration directly. Editing a live workflow changes its next run. Ask the person whether to process or skip held merges before activating a workflow that requires a backlog choice. Tests create proposals for review and never post to Slack; they count against docs-agent run limits. Deleting a workflow is available only in Pageloop; use pause_workflow to deactivate it through MCP.

See and manage the team

Any member with See the team can read the member directory. Admins and Editors see email addresses, roles, and invited or active status; Contributors see active members' IDs and names only. Inviting and resending invitations require an Editor or Admin. Only Admins can invite an Admin or change a member's role.

ToolPurposeKey inputsReturnsPermission
list_team_membersFind members and their IDs.None.Members with detail: full or detail: directory, depending on your role.See the team
invite_team_memberInvite someone to the workspace by email.first_name, last_name, email, role: admin, editor, or contributor.User ID, name, email, role, invited status, and which email was sent.Manage the team
resend_inviteSend another email to an invited member.user_id from list_team_members.User ID, email, and sent.Manage the team
change_member_roleChange another member's role immediately.user_id, role: admin, editor, or contributor.User ID, previous role, and resulting role.Manage the team; Admin only

Confirm the person's name, email, and role before inviting them: invitations and resends send real email. Confirm role changes before applying them. You cannot change your own role or demote the workspace's last active Admin. Copying an invitation sign-in link remains an in-app action.

Read and manage screenshot logins

Screenshot-login tools require an Admin, including reads. Use them for workspaces with Automated screenshots available in Settings. Adding, editing, or deleting a login stays in Pageloop; MCP never returns passwords or saved browser sessions.

ToolPurposeKey inputsReturnsPermission
get_screenshot_settingsInspect automated screenshot logins.None.feature_enabled, configuration, login IDs, names, roles, URLs, sign-in emails, instructions and rules, status, and latest tests.Read screenshot logins
list_screenshot_login_activityRead one login's activity.login_id; optional cursor.Admin edits, tests, and docs-agent capture activity, newest first, with next_cursor.Read screenshot logins
test_screenshot_loginStart a browser test using a saved login.login_id.Login ID, test_id, and queued status.Manage screenshot logins
get_screenshot_login_testFollow a Test Login.login_id, test_id.Status, step, failure reason, and start and finish times.Read screenshot logins
set_screenshot_login_enabledSwitch a saved login on or off.login_id, enabled (boolean).Updated login and Settings URL.Manage screenshot logins

A login must pass Test Login after its sign-in details change before it can be enabled. Poll a test no more than once every 10 seconds; a test can take about five minutes. If testing fails, fix the login under Settings → Automated screenshots. Use get_capture_failures in the Inbox group above for missing screenshots on a particular proposal.

Read settings, manage templates, and change the AI style

Any member with Read settings can list templates and read knowledge base settings. Changing templates or the AI style requires an Editor or Admin with Change settings. These changes take effect directly, outside a change set.

ToolPurposeKey inputsReturnsPermission
list_templatesFind article-creation templates, including IDs for starting a docs-agent run.None.Template IDs, names, example article IDs and titles, and timestamps.Read settings
create_templateSave a template based on workspace articles.name, nonempty article_ids from this workspace.Template ID, name, and selected articles.Change settings
delete_templateRemove a template without deleting its example articles.id from list_templates.Template ID and deleted.Change settings
update_org_styleChange the AI style's product description or product terms.product_description, product_terms, or both.Saved description and product terms.Change settings
get_kb_settingsRead knowledge base setup and operational status.None.Hosted-site status, repository connection and provider, latest build or sync, domain verification and SSL status, and import progress.Read settings

Templates cannot be edited through MCP: create a replacement and delete the old template. Read the AI style with get_org_context (Read pages). update_org_style preserves omitted fields; product_terms replaces the entire list. An empty description or empty terms list clears that field. Writing tone and other workspace settings cannot be changed with this tool. Theme and redirect changes use the change-set tools under Edit navigation and site settings, not update_org_style.

Inspect connected apps

ToolPurposeKey inputsReturnsPermission
list_integrationsCheck which services the workspace has connected.None.Service names and connected or disconnected status. No credentials, connection configuration, or repository names.Read pages

Prompts

Prompts return a playbook as a user message; retrieving one does not execute tools or create a proposal. They declare no prompt arguments. Give your assistant the relevant page, Inbox link, or shipped-change details in your conversation. Your connection must hold the prompt's required permissions on the same site.

PromptPurposeContext you provideReturns and intended outcomePermission
Document a change (document_a_change)Draft documentation for a shipped feature, endpoint, or behavior.What shipped, its evidence, and the relevant documentation area.Instructions to read workspace standards and existing pages, create a change set, and write drafts for review; stops before submission unless requested.Read pages + Draft changes
Review an inbox item (review_inbox_item)Review a Pageloop proposal and decide only the requested changes.An Inbox link or ID and which changes you want decided.Instructions to inspect entries and passages, read affected pages, record requested decisions and reasons, and leave unrequested decisions pending.Read pages + Review proposals
Audit a page (audit_a_page)Check one page against workspace standards without changing it.The page to audit.A read-only playbook: read workspace context and the page, search for contradictions if permitted, then report factual problems, missing information, and style issues in that order, quoting the exact text.Read pages

Audit a page does not edit content, open a change set, or propose a rewrite unless you ask for one. For a requested rewrite, use the Document a change flow.