Skip to main content
Connect an agent to your instance’s POST /mcp endpoint with a Workspaces API key. Set the client to use Streamable HTTP. This connection does not use a browser session or share link. Use the instance’s public API origin. Hosted Workspaces and the default container setup use the app origin. A Cloudflare self-hosted deployment uses its separate public API origin, not the Access-protected app origin.

Before you connect

You need:
  • A Workspaces account.
  • A Workspaces API key.
  • Your Workspaces public API origin.
  • An MCP client that supports Streamable HTTP and request headers.

Add the server to your client

Add a server with these fields to your client’s MCP settings: Clients store settings and secrets in different ways. Use this table as a field list, not as a configuration file. Do not save the raw key in a file you share or commit. Save the setting, then restart or reconnect the client. After it connects, the client lists the tools that this Workspaces instance supports.

Available tools

Follow the tool schemas your MCP client returns. Do not assume that a REST API route or an old tool list has an MCP equivalent.

Access and change records

The agent uses the key owner’s workspace ownership and current organization memberships. It does not inherit access from share links the owner has opened. Workspaces records the key and its owner with each change. Revoking the key stops MCP access. After a hosted organization removes the key owner, access granted by membership usually ends within 60 seconds. If Workspaces cannot refresh the membership list, cached access may last up to 10 minutes. Workspaces also gives the person’s organization workspaces to the admin who removes them, so the key loses owner access to those workspaces. The key remains active for personal workspaces, other organization memberships, and workspaces that are public or open to anyone with the link. Blocking sign-in does not revoke the key on hosted or self-hosted Workspaces. Only the key owner can revoke it.

Fix connection errors

Reviewed July 22, 2026. Maintained by the Plannotator documentation team.
Last modified on July 24, 2026