# 1. Configure (create config, enable one data source)
cp config-example.yaml config.yaml
# Edit config.yaml - set enabled: true for one plugin
# 2. Test locally
pip install aiohttp
python3 scripts/local_server.py
# 3. Deploy
./scripts/deploy.shConnect via Claude Connectors (same steps on both Claude.ai and Claude Desktop):
- Go to Settings → Connectors (or Customize → Connectors on claude.ai)
- Click Add custom connector
- Enter a name (e.g. "Boston OpenData") and your API Gateway URL
Get the URL: cd terraform/aws && terraform output -raw api_gateway_url
See Getting Started for full setup.
| Doc | Description |
|---|---|
| Getting Started | Setup and usage |
| Architecture | System design and plugins |
| Deployment | AWS, Terraform, monitoring |
| AWS Deployment (Boston) | Boston fork: region, concurrency, domain, packaging |
| Security | SQL hardening, rate limits, upstream-portal protection |
| Testing | Local testing (Terminal, Claude, MCP Inspector) |
- Boston OpenData (CKAN): examples/boston-opendata/config.yaml
- Custom plugin: examples/custom-plugin/
Pre-commit hooks (optional):
pip install pre-commit
pre-commit installHooks: Ruff, yamllint, gofmt. Run manually: pre-commit run --all-files.
MIT — see LICENSE.
Author: Srihari Raman, City of Boston Department of Innovation and Technology