<p align="center">
  <img src="icons/icon-dark.svg" width="96" alt="PairSync logo" />
</p>

<h1 align="center">PairSync</h1>

<p align="center"><strong>Pairs trading statistics</strong></p>

<p align="center">
  <a href="https://cursor.com/install-mcp?name=pairsync&config=eyJ1cmwiOiJodHRwczovL21jcC5wYWlyLXN5bmMuY29tL21jcCJ9">
    <img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install PairSync in Cursor" />
  </a>
</p>

---

## What it does

PairSync refits cointegration statistics every night across six markets
(US equities, US ETFs, EU, India, Australia, crypto) and serves the output
as ranked pair statistics: spread z-scores, locked parameters, calibration
records, and backtest-tracked spread states. Your AI can screen pairs, read
a pair's locked parameters, freeze a parameter recipe, generate
ready-to-paste chart and code templates, check a frozen list against the
latest refit output, read the plain-English methodology library, and fetch
a strategy-builder scaffold whose every decision is an owner-decision slot
your AI fills by asking you.

- **Server**: `https://mcp.pair-sync.com/mcp` (remote MCP, Streamable HTTP)
- **Tools**: 18, all read-only (statistics, templates, methodology library,
  strategy-builder scaffold, charts)
- **Markets / cadence**: US, US ETFs, EU, IN, AU, crypto — one refit per
  market per night
- **Rate limit**: 300 tool calls/hour per key
- **Documentation**: https://terminal.pair-sync.com/api

## Read-only by design

Every tool is read-only statistics and templates. PairSync has **no order
path, no custody, no execution**, and never manages money — prices,
decisions, and execution stay entirely on your side. Anything you choose to
freeze or persist is stored on your side; the server keeps nothing.

## Get an API key

1. Sign in (or sign up) at https://terminal.pair-sync.com
2. Open **Settings → API Access**
3. Mint an API key and copy it — you'll paste it into Cursor below

Your credentials stay private: you authenticate with a single PairSync API
key minted on your own account page. OAuth tokens are sealed, short-lived
envelopes of that key — the server stores no tokens, no sessions, and no
personal data.

## Connect from Cursor

### One-click install (OAuth)

Click the **Install in Cursor** badge above. Cursor walks you through
PairSync's OAuth sign-in — you paste the API key you minted once during
authorization, and you're connected.

PairSync's OAuth is standard OAuth 2.1 (RFC 9728 discovery, dynamic client
registration, PKCE), so the same zero-config entry works in any
OAuth-capable MCP client:

```json
{
  "mcpServers": {
    "pairsync": {
      "url": "https://mcp.pair-sync.com/mcp"
    }
  }
}
```

### Manual `mcp.json` (API-key header)

Prefer a header instead of OAuth? Add this to `~/.cursor/mcp.json` (or your
project's `.cursor/mcp.json`) and set the `PAIRSYNC_API_KEY` environment
variable to your key:

```json
{
  "mcpServers": {
    "pairsync": {
      "url": "https://mcp.pair-sync.com/mcp",
      "headers": {
        "X-Api-Key": "${env:PAIRSYNC_API_KEY}"
      }
    }
  }
}
```

## Example prompts

- `Show me tonight's leaders in US equities.`
- `Screen crypto pairs from the latest refit and explain the top one.`
- `Explain the PairSync methodology — where do I start?`
- `Check my frozen recipes against last night's refit output.`
- `Build me a connector template for this pair with the locked parameters.`

## What's in this repo

This repository contains only the plugin manifest, MCP configuration,
icons, and documentation for the hosted PairSync MCP server — no server
source code.

| File | Purpose |
|---|---|
| `plugin.json` | Agent Plugins (Open Plugins) manifest |
| `mcp.json` | Agent Plugins MCP configuration (OAuth) |
| `.mcp.json` | Cursor/Claude-style MCP configuration (OAuth) |
| `.cursor-plugin/plugin.json` | Cursor Marketplace manifest |
| `icons/` | Logo (dark + light, SVG + 512/256/128 PNG) |

## Disclaimer

PairSync provides educational statistics derived from historical market
data. It is not financial advice and makes no performance claims. Nothing
here directs trades or executes anything on your behalf.

## Support & policies

- Support: support@pair-sync.com
- Privacy policy: https://www.pair-sync.com/privacy
- Website: https://www.pair-sync.com

## License

[MIT](LICENSE)