Metadata-Version: 2.4
Name: syncscore-companion
Version: 0.1.0
Summary: Local companion MCP server for SyncScore audits — bridges filesystem access to the SyncScore remote MCP server
Requires-Python: >=3.10
Requires-Dist: fastmcp>=3.4.0
Description-Content-Type: text/markdown

# syncscore-companion

Local companion MCP server for [SyncScore](https://sync-score.vercel.app) audits.

Bridges local filesystem access with SyncScore's remote audit tools in a single
MCP server, so a customer's AI client (Claude Desktop, Cursor, etc.) only needs
to configure one `mcpServers` entry to run a full audit — no separate
filesystem MCP server required.

## Usage

Add to your MCP client config (e.g. `claude_desktop_config.json`):

```json
{
  "mcpServers": {
    "syncscore": {
      "command": "uvx",
      "args": ["syncscore-companion", "--project-path", "/absolute/path/to/your/project"],
      "env": { "SYNCSCORE_API_KEY": "sk_live_..." }
    }
  }
}
```

## What it does

- Exposes read-only, scoped filesystem tools (`read_file`, `list_directory`,
  `search_files`) rooted at `--project-path`. Excludes `.git`, `node_modules`,
  `.venv`, dotfiles/secrets, and files over 512KB.
- Transparently proxies SyncScore's remote audit tools
  (`start_audit`, `report_*`, `finalize_report`) to
  `https://syncscore-api.onrender.com/mcp`, injecting your API key as the
  `Authorization` header automatically.

## Local development

```bash
uv pip install -e ".[dev]"
pytest tests/
```
