Write, review and publish with Workover
Connect your WordPress site, write and review with your team, bring in your AI agent, and publish when it’s ready.
terminal
npm i -g @workover/cliworkover loginclaude mcp add workover -- npx -y @workover/mcp
Set up your AI agent
Connect the agent you already work in to your documentation. Paste this prompt into it, or follow the guides below.
Agent prompt
Help me set up Workover. Read https://workover.io/docs/cli-and-mcp first. Then: 1. Install the Workover CLI with `npm i -g @workover/cli` and sign in with `workover login`. It opens my browser so I can approve the connection. 2. If you are Claude Code, connect the Workover MCP server with `claude mcp add workover -- npx -y @workover/mcp`. 3. Run `workover projects` to list the projects I can reach, then suggest useful next steps, such as finding a document that is out of date and proposing an update for me to review.
The Workover CLISearch, read, create and propose edits to your documents from the terminal, with scopes you choose when you sign in.The MCP serverGive Claude Code and other agents your documentation: they search and read it, and every edit arrives as a suggestion you review.API keysCreate and revoke the keys scripts and integrations use to reach Workover.
What's new
The latest changes to Workover. Browse the full changelog.
Introducing Custom Brand Colors for Screenshot Annotations & App Connection MonitoringNew Workover now tracks whether your connected app's login still works Every crawl and screenshot capture now checks that signing in to…Improved App ConnectionsSaving new start pages or a new product root now triggers a fresh scan of the connected app right away, instead of waiting for the next…Introducing Support for Mintlify and Improved Automated ScreenshotsNew AI-generated screenshots now match the real screens of your connected app Drafting and screenshot capture now draw on the actual labels…
Getting Started
What is Workover?An overview of Workover: how workspaces and projects are organized, and how you write, review, draft with AI, publish to your site and monitor pages.Core conceptsLearn how workspaces, projects, documents and tabs fit together in Workover, and why a project is the boundary that decides who sees what.Quickstart: publish your first documentConnect a WordPress site to Workover, write a document from a blank page, and publish it as a live post or a draft, step by step from onboarding.How to connect a WordPress siteConnect a WordPress site to a new or existing Workover project, approve the connection in WordPress, and handle Cloudflare Access and connection errors.Inviting your teamInvite colleagues to your Workover workspace or add them to a single project, choose their roles, and remove access when they no longer need it.How to update your existing content with WorkoverUpdate a post that was on your WordPress site before Workover by editing its imported document and pushing, or by linking a document to the post.
The Editor
Editor basicsLearn the layout of the Workover editor, where the Edit panel's controls live, how saving works, and the ways to format, paste and insert content.Document tabsSplit a Workover document into tabs for briefs and research, add, nest, reorder and delete tabs, and choose the one tab that syncs to WordPress.Images and mediaInsert images and embedded videos in a Workover document, set alt text, captions and a featured image, and see what happens to images when you publish.How to insert a code blockInsert a code block in a Workover document from the / menu, toolbar or a shortcut, set its language, add inline code, and bring code in from Google Docs.Pasting MarkdownPaste Markdown into Workover and have it converted to formatted text, see which syntax converts, and force or skip the conversion when needed.Comments and suggestionsAdd, reply to and resolve comments on a Workover document, propose tracked suggestions, and review them one at a time or all at once.How to suggest editsTurn on Suggesting mode to record your edits in a Workover document as tracked changes, then accept or reject the suggestions before you publish.Version historyBrowse a Workover document's version history, save and name versions, restore an older version, or copy one into a new document.Exporting a documentCopy or download a Workover document tab as Markdown, download its images as a zip, and export your content before you leave Workover.Keyboard shortcuts and slash commandsLook up the Workover editor's keyboard shortcuts, typing shortcuts, slash commands and right-click menu items for formatting, blocks and zoom.
AI
How Workover AI worksLearn what Workover AI needs, where you use it to draft, revise and check documents, what it works from, and which changes arrive as suggestions.Choose who provides Workover AIChoose who provides Workover AI for your workspace, the included Workover AI or your own API key, and see which providers can read a code repository.Draft a document with Workover AIDraft a document with Workover AI from your workspace home or into a specific project, answer its plan or code questions, and fix drafting errors.Writing a good briefWrite a brief that gets a usable Workover AI draft: name the reader, the outcome, the shape and what to avoid, and give it the source material.Revising a document with AIRevise a document with Workover AI's Iterate, write instructions that work, review the tracked suggestions, and use quick edits on a selection.Style guidesSet workspace and project style guide rules that Workover AI follows, check a document against them, and learn what makes a rule worth adding.Grounding drafts in your code repositoryLink a code repository so Workover AI writes technical drafts from your code, see which AI providers can ground drafts, and check if a draft was grounded.Product screenshots in draftsConnect your product app so Workover AI drafts include screenshots of it, fill in the connection fields, and keep the screenshots current.Documentation reviewCheck published help articles against your product with documentation review, fix findings with Workover AI, and review docs when code merges.
Collaboration & Sharing
Sharing a documentShare a document with a teammate or someone outside your workspace, and choose what they can do.Roles and permissionsWhat owners, admins, members and guests can each reach.Guests and external collaboratorsBring in a freelancer or client without giving them the whole workspace — or a seat.Share linksCreate a link anyone can open, and what it does and does not expose.NotificationsSee which events Workover notifies you about, where notifications appear, and how to filter your inbox and change what you are emailed.Real-time editing and presenceSee who else is in a Workover document, follow a collaborator's cursor, and learn how simultaneous edits merge and when editing is one person at a time.Seeing who changed access to a documentFind who added, invited, removed or changed someone's access to a document in your workspace audit log, filter the entries and export them.
Monitor
What Monitor doesLearn what Monitor watches on your published pages, which problems it catches at what severity, and where to find each result in a site's tabs.How to add a site to MonitorAdd a site to Monitor by entering its address, see how it finds and checks your pages, and fix common problems such as no pages being found.Pages and crawl activityFilter and sort the pages Monitor tracks, open a page's detail tabs, and paste access logs to see which pages search engine bots crawl.Issues and severityUnderstand Monitor's Critical, Warning and Info severities, read the Issues tab, change a check's severity, and stop reporting findings that are fine.Changes and diffsSee which page attributes Monitor compares on each check, which changes email you, and how to find and read changes on the Changes tab.Platform and specification checksRead Monitor's Platform tab for uptime, HTTPS, certificate, robots.txt and sitemap checks, and the Specification tab for Website Specification results.Alerts and incidentsLearn how Monitor opens, groups and closes incidents, which alert rules email you by default, and how to change who is told and when.Monitor site settingsConfigure a Monitor site's checks, thresholds, alerts, Google reporting and crawling options, and pause or remove a site you no longer watch.
WordPress
How WordPress sync worksUnderstand how Workover pushes, pulls and syncs content with WordPress through the REST API, and what a project sync overwrites or protects.How to publish a document to WordPress for the first timeSend a Workover document to WordPress for the first time as a draft, pending, published or private post, schedule it, or link it to an existing post.How to push a document to WordPressPush edits from a linked Workover document to its WordPress post, see what a push sends, and handle a disabled Push button, conflicts and refusals.Pulling changes from WordPressPull the current WordPress version of a post into its linked Workover document, and see exactly what a pull replaces and what it leaves alone.Sync status and conflictsLook up each WordPress sync status in the WP tab and document list, what causes it, what clears it, and why a push can be stopped.Linking to other documents in a WordPress postLink one Workover document to another and see how links are rewritten to live WordPress URLs, or held, when you push, and what to do when one is held.Content types and collectionsChoose the WordPress content type a Workover document publishes as, see how the document list groups documents by type, and move a live post safely.Custom blocks, ACF and the block editorLearn how Workover handles custom blocks, ACF blocks and ACF fields in WordPress posts, and when to edit a post in the WordPress block editor view.Let Workover reach a site behind a firewall or Cloudflare AccessLet Workover reach a WordPress site behind a firewall, security plugin or Cloudflare Access by allowing its User-Agent or saving a service token.Application passwords are turned offTurn WordPress application passwords back on when a security plugin, host setting or missing HTTPS blocks them, then reconnect your site to Workover.Patchstack hardening settingsTurn off the Patchstack hardening settings that block WordPress application passwords or user enumeration so Workover can connect and list authors.
Integrations
Integrations overviewSee where each Workover integration lives, at the workspace, project or account level, what every connection is for, and what it can change.Connecting a code host (GitHub, GitLab, Bitbucket)Connect GitHub, GitLab or Bitbucket and link repositories to a project so Workover AI can read your code when it drafts documentation.SlackConnect Slack so Workover can send your notifications and Monitor alerts as direct messages, and turn a Slack message into a Workover draft.Connecting your support toolConnect Plain, Freshdesk, Zendesk or Intercom so Workover groups your recent support tickets into topics and shows which ones your docs miss.How to connect Webflow and publish to itConnect a Webflow site's CMS collections to a Workover project, push documents to Webflow as staged or live items, and handle changes made in Webflow.How to connect Mintlify and publish to itConnect a Workover project to a Mintlify docs site's GitHub repository, edit pages with Mintlify components, and publish by pull request or direct commit.Set up your agentInstall the Workover CLI, choose its scopes, approve the device in your browser, and add the Workover MCP server to Claude Code or another agent.CLI commands and MCP toolsLook up every Workover CLI command and MCP tool, the token scope each one needs, and what each scope, from read to publish, lets a token do.Access tokensReview the access tokens the Workover CLI and MCP server use, listed as Connected devices, and revoke any token you no longer use.Importing Markdown and pasting from Google DocsImport Markdown files into a Workover project in bulk, or paste a single Google Doc with its images, and see the import limits and skipped files.
Accounts & Billing
Plans and pricingCompare Workover Essentials, Managed documentation, Monitor and Enterprise, how each is billed, and who in a workspace can change billing.Members and seatsSee who occupies a paid seat in a Workover Essentials workspace, who does not, and when adding or removing seats is charged or credited.How to start your free trial or subscribeStart Workover Essentials for a workspace from Plan & billing with a 7-day free trial, choose annual or monthly, and see what happens after the trial.What happens when a payment fails or your plan endsSee each Workover billing state, what happens when a payment fails or a plan ends, what people in the workspace see, and who can fix it.How to cancel or resume your planCancel or resume your Workover Essentials plan, and see what happens to your workspace, documents and published posts when the plan ends.How to download invoices and set your billing detailsDownload Workover invoices from Plan & billing, add your company details and VAT or tax ID, and see who receives invoices and receipts.How to update your payment methodReplace the card on a Workover workspace's plan from Plan & billing when it expires or a payment fails, and fix a missing Payment method row.WorkspacesCreate, switch, rename or delete a Workover workspace, and learn what belongs to a workspace and when a second one, with its own bill, makes sense.How to turn on two-factor authenticationTurn on two-factor authentication for your Workover account with an authenticator app, sign in with a code, and keep your recovery codes safe.Your profileEdit your Workover profile fields, change your sign-in email, reset your password, and review the CLI and MCP tools connected to your account.
Troubleshooting / Common Errors
Common errorsLook up the exact error messages Workover shows when connecting a site, pushing to WordPress, syncing or using the CLI, and what each one means.How to fix a push to WordPress that failedFix a push to WordPress that did not update the post, whether Push is disabled, a Before you push dialog appears or WordPress refuses the push.How to fix images that are missing after publishingFix images that are broken or missing on a WordPress post after you publish from Workover, from user roles and blocked uploads to uncopied pastes.“New changes in WordPress” keeps coming backFind out why a document keeps showing New changes in WordPress after a pull, track down the plugin re-saving the post, and decide how to fix it.Contacting supportSend the Workover team a support request from the app, by email or through the contact form, see what to include, and how to report a security issue.