# Polylane Developers

> Everything you need to build against Polylane: the API, the MCP server, the CLI, the SDK, and how to authenticate. Polylane detects production issues and fixes them by opening pull requests.

Canonical: https://polylane.com/developers · Documentation: https://docs.polylane.com

## Quickstart

1. **Install**: `curl -fsSL https://polylane.com/setup | bash` installs the CLI, registers the MCP server in every coding agent on the machine, and signs you in, which creates the account and the workspace (https://polylane.com/setup).
2. **Connect**: at https://console.polylane.com, connect a cloud account or repository.
3. **Mint an API key**: create a key (`sk_...`) in the console settings.
4. **First request**:

```
curl https://api.polylane.com/v1/auth/whoami -H "x-api-key: sk_..."
```

5. **Connect an agent**: point any MCP client at `https://mcp.polylane.com/mcp` (Streamable HTTP). OAuth clients can register themselves at `https://mcp.polylane.com/register`; API keys work as `Authorization: Bearer sk_...` or `x-api-key`.

## The Polylane API

- Base URL: `https://api.polylane.com/v1`
- OpenAPI 3.0 spec: https://api.polylane.com/v1/doc (mirrored at https://polylane.com/openapi.json)
- API catalog (RFC 9727): https://polylane.com/.well-known/api-catalog
- Authentication guide for agents: https://polylane.com/auth.md

## MCP servers

- **Product** (OAuth 2.0 or API key): `https://mcp.polylane.com/mcp`. Its tools are listed in the server card, which the server publishes itself: https://mcp.polylane.com/.well-known/mcp/server-card.json
- **Docs** (no auth): `https://docs.polylane.com/mcp`, which lists and reads every page of https://docs.polylane.com
- **Registry**: [Smithery](https://smithery.ai/servers/coreplanelabs/polylane)

## CLI

Built to be driven by coding agents: structured output and non-interactive flags everywhere.

```
curl -fsSL https://polylane.com/setup.sh | bash        # macOS / Linux
irm https://polylane.com/setup.ps1 | iex               # Windows
polylane auth signup --email you@example.com
```

Full CLI documentation: https://docs.polylane.com/tools/cli

## SDK

- npm: https://www.npmjs.com/package/@coreplane/polylane

## Rate limits

Requests are rate limited per credential. When you exceed a limit the API returns `429`: back off and honour `Retry-After` when present. Agents should treat any `429` as a signal to retry with exponential backoff rather than tight-looping.

## Versioning and deprecation

The API is versioned in the URL path (`/v1`). Breaking changes only ship in a new version. Deprecations are announced and documented in the [docs](https://docs.polylane.com) before removal; deprecated surfaces keep working during the transition window.

## Machine-readable entry points

- https://polylane.com/llms.txt: site index for agents
- https://polylane.com/agent.json: structured product view (also at https://polylane.com/?mode=agent)
- https://polylane.com/.well-known/mcp: MCP discovery
- https://polylane.com/.well-known/agent-skills/index.json: skills index

## Status

Live availability of the Polylane platform: https://polylanestatus.com

## Support

Email support@polylane.com or reach us on X at https://x.com/polylane.