Skip to content
voidputPublic

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

Star Citizen MCP (SCMCP)

CI/CD Docker Image Version License: ISC

A Model Context Protocol (MCP) server providing real-time access to Star Citizen market data, trade routes, and wiki information. This MCP is designed to enable AI assistants like Claude and Gemini to seamlessly retrieve the latest Star Citizen trading data and lore directly into your chat!

Features

  • Commodity Prices & Averages: Fetch current and historical pricing for commodities via UEX. Understand the economy.
  • Trade Routes: Find profitable trade routes based on your cargo capacity and available investment. Maximize your aUEC.
  • Terminal & Location Data: List trading terminals, outposts, and cities across systems like Stanton and Pyro.
  • Wiki Search: Query the Star Citizen Wiki and Star Citizen Tools for ships, items, components, and lore.
  • Built-in Caching: API responses are automatically cached in-memory for 5 minutes to significantly reduce latency and redundant network requests.

Available Tools

UEX Economy Tools

  • uex_get_commodities: List all commodities in the game.
  • uex_get_commodity_prices: Get current commodity prices (filterable by system, planet, and terminal).
  • uex_get_commodity_averages: Get historical average prices over time.
  • uex_get_terminals: List trading terminals (filterable by system and planet).
  • uex_get_trade_routes: Find optimized, high-profit trade routes based on your ship's SCU and starting investment.
  • uex_get_commodity_ranking: Rank commodities by their profitability metrics.

Star Citizen Wiki Tools

  • scw_search: Search the Star Citizen Wiki for any topic.
  • scw_get_vehicle: Retrieve detailed ship and ground vehicle data, including manufacturer and stats.
  • scw_get_item: Retrieve weapon, armor, and ship component data.

Star Citizen Tools (starcitizen.tools)

  • sct_search: Search Star Citizen Tools (starcitizen.tools) for any topic.
  • sct_get_article: Get the text content of an article from Star Citizen Tools (e.g. for lore, character info, or detailed guides).

Patch History & Extracted Game Data

  • sc_list_builds: List the game builds that have a data dump, newest first.
  • sc_diff_versions: Diff any dataset between two patches — what was added, removed, and every changed field for one ship, weapon or component.
  • sc_local_datasets / sc_search_local / sc_read_local_collection: Query the game data extracted from your own install — mining spawns, blueprints, missions, reputation and Wikelo trades, none of which any public API serves.

Configuration

Variable Required Purpose
UEXTOKEN for UEX tools UEX Corp API bearer token
GITHUB_TOKEN no Raises the GitHub rate limit when listing or fetching build dumps
SCMCP_DATA_REPO no Data repo holding the per-build dumps (default voidput/sc-gamedata-dumps)
SCMCP_DATA_REPO_PATH no Path to the dumps inside that repo (default data)
SCMCP_BUILD_CACHE_DIR no Where fetched dumps are cached (default .build-cache/)
SCMCP_GAME_DATA_DIR no Directory of local game-*.json files, for the sc_*_local tools
SCMCP_SNAPSHOT_DIR no Where wiki-API snapshots are written (default .snapshots/)

Installation & Local Development

Create a .env file in the root directory and add your UEX API token:

UEXTOKEN=your_uex_api_token

Automated Setup

We provide a convenient installation script that will build the MCP and automatically add it to your Claude Code or Gemini CLI:

./install.sh

Manual Setup

Install dependencies:

npm install

Run linting and formatting:

npm run lint
npm run format

Run tests:

npm run test

Start the MCP server:

npm run build
npm start

Docker

Multi-arch images (linux/amd64, linux/arm64) are built, tested, and published to Docker Hub on every release.

docker pull voidput/scmcp           # latest release
docker pull voidput/scmcp:1.2.3     # exact version
docker pull voidput/scmcp:1.2       # latest patch of 1.2
docker pull voidput/scmcp:1         # latest minor of 1.x

docker run -e UEXTOKEN=your_token voidput/scmcp

Prereleases ship from branch name: develop/dev cut X.Y.Z-beta.N and move the beta tag, next cuts X.Y.Z-next.N and moves next. Prereleases never move latest, :1 or :1.2 — those stay on the newest stable build.

docker pull voidput/scmcp:beta            # newest develop/dev prerelease
docker pull voidput/scmcp:1.3.0-beta.2    # exact prerelease

Every push to a release branch also publishes a sha-<commit> tag for the exact build, released or not. :main is kept alive as a straight alias of :latest (same image, same stable release) for anyone still pulling the old tag.

Credits & Data Sources

SCMCP stores no game data of its own — every answer comes from somebody else's work. Each request carries a SCMCP/<version> (+https://github.com/voidput/SCMCP) User-Agent so these projects can see who is calling.

Source Used for Terms
UEX Corp (API) Commodity prices, terminals, trade routes, ship purchase/rental locations Requires an API token and attribution — see the "Powered by UEX" badge below
Star Citizen Wiki (API) Ships, items, components, shop data Content CC BY-NC-SA 4.0 — non-commercial
Star Citizen Tools Article search and lore text Content CC BY-SA 4.0
StarBreaker Local DataCore/DataForge extraction behind sc_*_local tools Reverse-engineering toolkit
Model Context Protocol SDK The MCP server itself MIT

Wiki text reproduced through this server stays under its own licence: attribute the wiki it came from and share alike. The Star Citizen Wiki's content is non-commercial — that restriction travels with the data, not with this server.

This is an unofficial Star Citizen fan project, published non-commercially. It uses no Cloud Imperium assets, artwork or branding of any kind.

This site is not endorsed by or affiliated with the Cloud Imperium or Roberts Space Industries group of companies. All game content and materials are copyright Cloud Imperium Rights LLC and Cloud Imperium Rights Ltd. Star Citizen®, Squadron 42®, Roberts Space Industries®, and Cloud Imperium® are registered trademarks of Cloud Imperium Rights LLC. All rights reserved.

Release & Versioning

This project uses semantic-release to automate versioning and changelog generation based on commit messages. Follow conventional commit standards (e.g., feat:, fix:) to trigger automated releases!

Branch Channel Version shape
main stable 1.4.2
develop, dev beta 1.5.0-beta.1
next next 2.0.0-next.1

Powered by UEX

This site is not endorsed by or affiliated with the Cloud Imperium or Roberts Space Industries group of companies.
All game content and materials are copyright Cloud Imperium Rights LLC and Cloud Imperium Rights Ltd.
Star Citizen®, Squadron 42®, Roberts Space Industries®, and Cloud Imperium® are registered trademarks of Cloud Imperium Rights LLC. All rights reserved.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages