Versioning

Pink Editor's API has one version number, covering the MCP tools and their inputs and results. The current, and only, version is 1.

Choosing a version

Send the version with each request, either way:

Most MCP clients can't set custom headers, which is why the query string works too: put it in the URL you paste into the client. Send neither and you get version 1.

Every response says which version answered, in the Pink-Version header, along with Pink-Request-Id. A version the server doesn't speak is refused with unsupported_api_version, which lists the supported ones.

These docs show version 1. When a version 2 exists, the API version switch at the top of the sidebar shows its pages; a docs link can pick one too, with ?api_version= on the docs URL.

What changes without a new version

Within a version we only make changes that a client written against it keeps working with:

• New tools. Your client sees them the next time it reconnects and calls tools/list. There is no list-changed notification, so a running session keeps the list it started with.
• New optional parameters on existing tools, and new fields in results. Ignore fields you don't know.
• New error codes. Treat an unknown code as a failure and read its message.
• Clearer tool descriptions. Descriptions are instructions for the model and are tuned over time.
• Price changes. Prices are list prices and can change; see Credits.

Renaming or removing a tool, removing a parameter, or changing what a result field means needs a new version. When a tool is renamed within a version, the old name keeps working as an alias; only the new name is listed.

The stdio bridge

The local bridge (@editpink/mcp and the Claude Desktop .dxt) has its own release number. When a bridge is older than the current release, the server answers its tool calls with an update message instead of running them:

{
  "_bridge_update_required": true,
  "your_version": "0.10.0",
  "latest_version": "0.11.0",
  "update_url": "https://app.edit.pink/connect",
  "message": "Your Pink Editor MCP bridge is out of date and tool calls are blocked until you update to 0.11.0. Open https://app.edit.pink/connect to download the latest Claude Desktop .dxt, or switch to the remote MCP URL (paste once, never goes stale)."
}

Download the latest .dxt from the Connect page, or switch to the remote URL https://app.edit.pink/api/mcp, which is always current. The remote server never sends this message.

The bridge also refreshes its tool list and instructions from the server in the background. A change it picks up takes effect the next time your client starts it.

The Publish Protocol

The Publish Protocol between Pink and your site is versioned separately, by the X-CM-Protocol-Version header. It is at version 1.