From c64158da944028d36889c750793989c7469b2074 Mon Sep 17 00:00:00 2001 From: Latte <1+latte@noreply.hiddenden.cafe> Date: Mon, 29 Jun 2026 13:46:52 +0000 Subject: [PATCH] Add Tool Reference wiki page --- Tool-Reference.md | 182 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 182 insertions(+) create mode 100644 Tool-Reference.md diff --git a/Tool-Reference.md b/Tool-Reference.md new file mode 100644 index 0000000..e7a7f2a --- /dev/null +++ b/Tool-Reference.md @@ -0,0 +1,182 @@ +# Tool Reference + +Every MCP tool familiar exposes, grouped by module (~80 in total). All tools follow the conventions in **[Architecture](Architecture)**: + +- **Read tools** take an *optional* `character` (name or id). Omit it to run across **all** logged-in characters; pass one to scope to that character. Public tools (market, universe, zKill) need no login at all. +- **Write tools** (marked **WRITE**) take a *required* `character` and a `confirm` flag. With `confirm=false` (the default) they return a dry-run preview and change nothing. See **[Write Safety](Write-Safety)**. +- **Corp tools** resolve each character's corporation and require the relevant **corp role**, or ESI returns 403 for that character. + +## Health + +| Tool | Description | +|------|-------------| +| `ping` | Health check — confirms the server is alive and reports name, version, UTC time. | +| `write_status` | Whether familiar is currently allowed to perform write actions. | +| `sde_status` | Whether the local SDE is available, and the path it's expected at. | +| `account_status` | Which characters familiar is logged in as (no network call). | + +## Market — public, no auth + +| Tool | Description | +|------|-------------| +| `list_hubs` | List the known NPC trade hubs and their region/system/station IDs. | +| `get_market_price` | Best buy/sell price and spread for an item at a trade hub. | +| `get_market_orders` | Order book: best limit sell or buy orders for an item at a hub. | +| `compare_hubs` | Compare an item's best sell/buy price across every known trade hub. | + +## Universe — public, no auth + +| Tool | Description | +|------|-------------| +| `resolve_names` | Resolve EVE names (items, systems, regions, stations) to their IDs. | +| `get_item` | Look up an item/type by name or id (volume, group, description). | +| `get_system` | Look up a solar system: security status, region, counts. | +| `get_station` | Look up a station: which system, type, and services. | +| `get_region` | Look up a region by name or id. | +| `get_route` | Number of jumps and the system path between two systems. | + +## Account — authenticated read + +| Tool | Description | +|------|-------------| +| `get_wallet` | Wallet balance (ISK) for one character or all. | +| `get_skills` | Total SP, unallocated SP, and skill count. | +| `get_skill_queue` | Upcoming skill-queue entries. | +| `get_location` | Current system/station, active ship, online status. | +| `get_clones` | Home station, jump clones, active implants. | +| `get_assets` | Asset summary (total stacks + a sample). | + +## Industry — character + corp read + +| Tool | Description | +|------|-------------| +| `get_industry_jobs` | Active/queued industry jobs. | +| `get_blueprints` | Owned blueprints (ME/TE, runs). | +| `get_mining_ledger` | Personal mining ledger (recent mined ore by day). | +| `get_corp_industry_jobs` | Corp industry jobs *(Factory Manager role)*. | +| `get_corp_blueprints` | Corp blueprints *(corp role)*. | + +## Trade — character + corp read + +| Tool | Description | +|------|-------------| +| `get_contracts` | Personal contracts. | +| `get_my_orders` | Open market orders *you* placed (not a hub book). | +| `get_corp_contracts` | Corp contracts *(corp role)*. | +| `get_corp_orders` | Corp market orders *(Accountant/Trader role)*. | + +## Structures — authenticated read + +| Tool | Description | +|------|-------------| +| `search_structures` | Search structures by name *(needs structure access)*. | +| `get_structure` | Info for one structure (name, system, type, owner). | +| `get_structure_market` | Market orders inside a player structure. | +| `get_container_logs` | Corp container audit logs *(corp role)*. | + +## Killmails — read + zKill + +| Tool | Description | +|------|-------------| +| `get_killmails` | Recent killmails (most recent enriched with detail). | +| `get_corp_killmails` | Recent corp killmails *(corp role)*. | +| `get_zkill_stats` | PvP stats from zKillboard *(public, no auth)*. | + +## Profile / social — authenticated read + +| Tool | Description | +|------|-------------| +| `get_loyalty_points` | Loyalty points per NPC corporation. | +| `get_standings` | Standings toward NPC entities. | +| `get_medals` | Awarded medals. | +| `get_titles` | Corp titles held. | +| `get_agents_research` | Active R&D agent research. | +| `get_notifications` | Recent notifications. | +| `get_chat_channels` | Owned/operated chat channels. | +| `get_jump_fatigue` | Jump fatigue / clone-jump timers. | + +## Corp organization — corp-role read + +| Tool | Description | +|------|-------------| +| `get_corp_members` | Corp member character ids *(corp role)*. | +| `get_corp_member_tracking` | Member tracking: last login, location, ship *(Director)*. | +| `get_corp_divisions` | Hangar/wallet division names *(Director)*. | +| `get_corp_titles` | Corp titles and their granted roles *(corp role)*. | +| `get_corp_medals` | Corp medals *(corp role)*. | +| `get_corp_standings` | Corp standings toward other entities *(corp role)*. | +| `get_my_corp_roles` | The character's *own* corp roles (no special role needed). | + +## Corp economy & facilities — corp-role read + +| Tool | Description | +|------|-------------| +| `get_corp_wallets` | Balances of the corp's wallet divisions *(Accountant/Junior Accountant)*. | +| `get_corp_assets` | Corp assets *(Director)*. | +| `get_corp_mining` | Corp mining observers (moon drills etc.) *(Accountant)*. | +| `get_corp_facilities` | Corp industry facilities *(Factory Manager)*. | +| `get_corp_starbases` | Corp starbases / POSes *(Director)*. | + +## Misc — FW, projects, freelance, activities, access + +| Tool | Description | +|------|-------------| +| `get_fw_stats` | Faction-warfare stats. | +| `get_corp_fw_stats` | Corp faction-warfare stats *(corp role)*. | +| `get_freelance_jobs` | Freelance jobs available/accepted. | +| `get_corp_freelance_jobs` | Freelance jobs posted by the corp *(corp role)*. | +| `get_corp_projects` | Corp projects *(corp role)*. | +| `get_activities` | Character activity tracking. | +| `get_access_lists` | Access control lists (ACLs). | + +## Planetary interaction — read + +| Tool | Description | +|------|-------------| +| `get_planets` | Planetary colonies (planet, type, upgrade level). | +| `get_planet_layout` | Full layout (pins, links, routes) of one colony. | +| `get_corp_customs_offices` | Corp customs offices / POCOs *(corp role)*. | + +## Comms — mail & calendar (read + write) + +| Tool | Description | +|------|-------------| +| `get_mail` | Recent mail headers. | +| `read_mail` | Full body of a single mail. | +| `get_calendar` | Upcoming calendar events. | +| `send_mail` **(WRITE)** | Send an EVE mail from a character. | +| `set_mail_read` **(WRITE)** | Mark a mail read/unread. | +| `respond_calendar_event` **(WRITE)** | Respond to a calendar event (accepted/declined/tentative). | + +## Contacts (read + write) + +| Tool | Description | +|------|-------------| +| `get_contacts` | Personal contacts. | +| `get_corp_contacts` | Corp contacts *(corp role)*. | +| `get_alliance_contacts` | Alliance contacts (resolved via each character's corp's alliance). | +| `add_contacts` **(WRITE)** | Add personal contacts with a standing. | +| `remove_contacts` **(WRITE)** | Remove personal contacts. | + +## Fittings (read + write) + +| Tool | Description | +|------|-------------| +| `get_fittings` | Saved ship fittings. | +| `create_fitting` **(WRITE)** | Save a new fitting. | +| `delete_fitting` **(WRITE)** | Delete a saved fitting. | + +## Fleet (read + write) + +| Tool | Description | +|------|-------------| +| `get_fleet` | Current fleet (settings + member count). | +| `invite_to_fleet` **(WRITE)** | Invite a character to a fleet. | +| `update_fleet` **(WRITE)** | Update fleet MOTD / free-move setting. | + +## UI commands (write only) + +| Tool | Description | +|------|-------------| +| `set_waypoint` **(WRITE)** | Set/append an autopilot waypoint in the client. | +| `open_window` **(WRITE)** | Open an in-game window (market, information, contract). |