LatteandClaude Opus 4.8
77e47e75aa
Expand config.SCOPES to the complete character + corp scope set (64 read, 9 write), split into READ_SCOPES / WRITE_SCOPES so a caller can opt into a read-only subset via FAMILIAR_SCOPES. Update the README: familiar is no longer "read-only by design" — reads are free, writes are opt-in, previewed, and audited. Part of #17. Note: changing scopes requires re-running `familiar login` per character to re-consent. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
58 lines
3.9 KiB
Markdown
58 lines
3.9 KiB
Markdown
# familiar
|
||
|
||
> Your familiar across New Eden — an EVE Online MCP server that lets a local AI see your whole account and the universe, and act on your behalf when you ask.
|
||
|
||
In EVE, your familiar isn't a cat on the windowsill. It's the companion that rides along through New Eden, sees what you see, remembers what you can't, and fetches — or does — whatever you ask. `familiar` is exactly that: an [MCP](https://modelcontextprotocol.io) server that gives a local AI (Claude Code, Claude Desktop, Cowork) a complete window into your EVE Online account and the entire game universe, plus hands to act on it.
|
||
|
||
Ask your familiar where your assets are, what your skill queue looks like, what Tritanium sells for in Jita, the safest route to a lowsec system, or whether a fit is worth building — and have it set a waypoint or draft a mail when you say so. It looks, it finds, it reports back, and it acts when asked.
|
||
|
||
## Principles
|
||
|
||
- **Safe by default.** Reading is free; every *write* — sending mail, setting waypoints, editing contacts/fittings/PI, fleet commands — is off until you turn it on, previewed before it runs, and recorded in an audit log. The AI can see everything and changes nothing unless you let it.
|
||
- **Local-first.** Runs on your own machine. Your refresh token and account data never leave your control.
|
||
- **Everything, eventually.** The goal is full coverage: the ESI scopes you grant (character *and* corp, read and write), plus the complete static universe. Built in phases so it actually ships.
|
||
|
||
## How it works
|
||
|
||
Two data sources sit behind the server:
|
||
|
||
- **ESI** (the [EVE Swagger Interface](https://esi.evetech.net/)) — the official REST API. Public endpoints (market, universe, industry indices) need no login. Character and corp data (wallet, assets, skills, industry, contracts, mail, location, and more) come through EVE SSO with **read and write OAuth2 scopes** across both character and corp; write scopes power the opt-in actions.
|
||
- **SDE** (the [Static Data Export](https://developers.eveonline.com/resource/resources)) — the full static dataset of items, blueprints, systems and stations, cached locally for fast lookups and anything name- or recipe-based.
|
||
|
||
Built in **Python with FastMCP**, OAuth via PKCE with a localhost callback, refresh token stored encrypted on disk. ESI `Expires` headers are respected for caching, and the SDE is loaded into a local store.
|
||
|
||
## Roadmap
|
||
|
||
Built in phases. Each phase is independently useful, so the project stays shippable.
|
||
|
||
**Phase 0 — Skeleton**
|
||
- Repo, project scaffold, FastMCP server that starts and exposes a health/ping tool.
|
||
- App registered on [developers.eveonline.com](https://developers.eveonline.com/).
|
||
|
||
**Phase 1 — Public lookups (no auth)**
|
||
- Market: prices and order book for any item in any hub, spreads between hubs.
|
||
- Universe via SDE: items, systems, stations, security, basic route/jumps.
|
||
- Quick win: useful before any OAuth complexity exists.
|
||
|
||
**Phase 2 — Account read (OAuth)**
|
||
- EVE SSO login flow, encrypted refresh token storage.
|
||
- Wallet, assets (search across characters), skills + skill queue, current location and clones.
|
||
|
||
**Phase 3 — Industry & contracts**
|
||
- Industry jobs, blueprints (SDE-backed), manufacturing cost/profit lookups.
|
||
- Personal and corp contracts, market orders.
|
||
|
||
**Phase 4 — Everything else**
|
||
- Mail, planetary interaction, loyalty points, fittings, corp roles.
|
||
- zKillboard integration for kill/PvP data.
|
||
|
||
**Phase 5 — Polish**
|
||
- Caching, error-limit safety, packaging, setup docs. Optional: prep a public, generic single-user release as a portfolio case.
|
||
|
||
## Status
|
||
|
||
Phases 0–2 done on `dev`: public market & universe lookups, EVE SSO (PKCE) login with an encrypted token store, and read-only account tools (wallet, skills, location, clones, assets) across multiple characters and accounts. Now expanding to full character + corp coverage with opt-in writes (Phases 3–5). `main` stays untouched until the first complete version is ready.
|
||
|
||
## License
|
||
|
||
MIT |