Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.openlens.com/llms.txt

Use this file to discover all available pages before exploring further.

OpenLens exposes a remote MCP server so agents can onboard clients, run visibility scans, read every metric the dashboard shows, and manage projects on your behalf. One OAuth sign-in, no API keys to copy.

Quick reference

Server URLhttps://openlens.com/mcp
TransportStreamable HTTP
AuthOAuth 2.1 (browser flow)
stdio fallbacknpx -y mcp-remote https://openlens.com/mcp

Install in your client

Open claude.ai/customize/connectors, click Add custom connector, and enter https://openlens.com/mcp. The connector then shows up in Claude.ai web, Claude Desktop, and Claude Code automatically.

Verify it works

From any client, ask the agent:
“List my OpenLens projects.”
The agent should call list_projects and return at least one row.

Troubleshooting

  • Auth error or “needs client registration”: sign out of your client and reconnect. The OAuth handshake has to complete on first install.
  • Stale token: clear the mcp-remote cache with rm -rf ~/.mcp-auth/ and retry.
  • VS Code: “server failed to start”: Node 18+ has to be on PATH so the editor can spawn npx.
  • Anything else: email contact@aibread.com with the client, version, and the exact error.

Available tools

The server exposes ~40 tools across project setup, brands, platforms, topics, prompts, prompt attributes, runs, visibility analytics, workstreams, and scheduling. See the tools reference for the full list grouped by surface.