Back to Browse

Qlib Sync MCP Server

Developer ToolsLow Risk10.0MCP RegistryLocal
Free

Server data from the Official MCP Registry

Install, update, and read a local Qlib China A-share daily dataset, with checksums and rollback.

About

Install, update, and read a local Qlib China A-share daily dataset, with checksums and rollback.

Security Report

10.0
Low Risk10.0Low Risk

Valid MCP server (0 strong, 2 medium validity signals). No known CVEs in dependencies. Package registry verified. Imported from the Official MCP Registry.

10 files analyzed · 1 issue found

Security scores are indicators to help you make informed decisions, not guarantees. Always review permissions before connecting any MCP server.

Permissions Required

This plugin requests these system permissions. Most are normal for its category.

file_system

Check that this permission is expected for this type of plugin.

env_vars

Check that this permission is expected for this type of plugin.

HTTP Network Access

Connects to external APIs or services over the internet.

What You'll Need

Set these up before or after installing:

Dataset folder; defaults to ~/.qlib/qlib_data/cn_dataOptional

Environment variable: QLIB_SYNC_DATA_DIR

Optional prefix-style GitHub proxy for slow connections, e.g. https://ghfast.topOptional

Environment variable: QLIB_SYNC_MIRROR

How to Install

Add this to your MCP configuration file:

{
  "mcpServers": {
    "qlib-sync": {
      "command": "uvx",
      "args": [
        "qlib-sync==0.2.0"
      ]
    }
  }
}

Some servers take additional arguments. See the repository for details.

Documentation

View on GitHub

From the project's GitHub README.

qlib-sync

CI PyPI License: MIT

中文说明

Website: randyy179.github.io/qlib-sync

One command to install and keep current a local Qlib China A-share dataset, and an MCP server so AI assistants can read it.

pip install qlib-sync
qlib-sync cn update

Or without installing anything first: uvx --python 3.12 qlib-sync cn update. (--python 3.12 because pyqlib publishes wheels up to Python 3.12; uv fetches that Python for you if needed. With pip, use Python 3.10 to 3.12.)

qlib-sync updating the dataset: status, download with progress, checksum, summary, then an instant no-op

That installs the daily community release from chenditc/investment_data into ~/.qlib/qlib_data/cn_data, the location Qlib reads by default. Run the same command again any time; when the data is already current it finishes in about a second.

Why not just wget and tar?

Qlib's README points A-share users to the community release with a wget and tar one-liner. That works until it doesn't:

  • An interrupted or truncated download extracts into a half-written dataset, or fails after the old one has already been overwritten.
  • Upstream republishes releases. In November 2026 a data error was found and corrected (investment_data#163) and releases were republished under the same date. A date check alone never sees the fix.
  • Every check downloads 550 MB, even when nothing changed.

The investment_data README itself describes a careful manual process: download the release manifest, check the archive with qlib/validate_archive.py --require-publishable, then extract. qlib-sync runs that validator itself, on every update: an unmodified copy (from commit 68fdc66, Apache-2.0) checks the manifest before the download and the archive after it. A test suite feeds the same malformed releases to the upstream script and to qlib-sync and requires the same verdict, and a weekly job flags any change upstream makes to the validator.

On top of that, qlib-sync skips the download when nothing changed, pins the manifest and the archive to one release tag, extracts beside the live data and swaps it in with rollback (rather than extracting on top of the existing folder), and picks up republished releases.

qlib-sync treats the dataset like a production system:

StepWhat happens
CheckPins the latest release by tag and reads its 500-byte manifest. Already current: done, nothing downloaded.
DownloadResumes interrupted downloads; shows progress; optional mirror for slow links to GitHub.
Verifyinvestment_data's own validate_archive.py --require-publishable, unmodified: manifest fields and formats, size and sha256, every required calendar and index pool, date formats, ordering, and the future calendar. Anything it rejects is refused.
StageExtracts next to the active dataset; refuses downgrades.
SwapRenames the new dataset into place, then runs a real Qlib read.
Roll backAny failure after the swap moves the previous dataset back.
ReportNew trading days, newly listed and delisted symbols.

Verification is required by default. If the manifest is missing, unreadable, or rejected by the validator, the update stops and your data stays as it was. --allow-unverified installs anyway when the manifest cannot be verified, and the result and install record are then marked unverified; a package whose checksum disagrees with a valid manifest is always refused.

The checks catch broken, truncated, tampered, or malformed packages. They cannot catch wrong values inside a correctly published release (like the one in #163); for that, keep a rollback copy with --keep-backup.

Commands

qlib-sync status                  # every local Qlib dataset at a glance
qlib-sync cn status               # local date, pools, and whether a newer release exists
qlib-sync cn update               # install or update (add --json for machine-readable output)
qlib-sync cn health-check         # structure checks plus a real Qlib read
qlib-sync cn restore --list       # rollback backups; restore --yes switches back

Useful options for cn update:

OptionEffect
--data-dir PATHInstall somewhere other than ~/.qlib/qlib_data/cn_data
--mirror URLDownload through a prefix-style GitHub proxy such as https://ghfast.top (or set QLIB_SYNC_MIRROR)
--keep-backupKeep the previous dataset for one rollback
--protect FILECarry a custom stock pool in instruments/ across updates (repeatable)
--forceReinstall even when the dates match
--allow-unverifiedInstall when the manifest cannot be verified (marked unverified; checksum mismatches are still refused)

The update replaces the whole cn_data folder. Anything you added there is lost unless you pass it with --protect.

Mirrors

From mainland China, GitHub downloads can be slow or fail. Pass a mirror and qlib-sync downloads the package through it while still reading the manifest from GitHub directly when it can, so the checksum does not depend on the mirror. Mirrors are third-party services; qlib-sync does not endorse any of them.

Python

from qlib_sync import update_cn, status_cn, health_check_cn

result = update_cn()                 # raises qlib_sync.UpdateError on failure; data unchanged
print("\n".join(result.summary_lines()))
print(result.new_trading_days, result.added_symbols)

Use it from your AI assistant

qlib-sync includes an MCP server, the open standard most AI tools use to call local tools. Any MCP client that can start a local command works, whichever model it runs: Claude, GPT, Gemini, DeepSeek, Qwen, Kimi, GLM, or a local model. The server runs on your machine and reads the dataset there; there is no service to host and nothing leaves your computer. It is listed in the MCP Registry as io.github.randyy179/qlib-sync.

Every client needs the same two things: the command uvx and the arguments qlib-sync mcp.

ClientHow to add qlib-sync
Claude DesktopDownload qlib-sync.mcpb from the latest release and open it
Claude Codeclaude mcp add qlib-sync -- uvx --python 3.12 qlib-sync mcp
OpenAI Codex CLIcodex mcp add qlib-sync -- uvx --python 3.12 qlib-sync mcp
CursorThe JSON below, in ~/.cursor/mcp.json
Gemini CLIThe JSON below, in ~/.gemini/settings.json
Qwen CodeThe JSON below, in ~/.qwen/settings.json
Tencent CodeBuddy, ByteDance Trae, Alibaba Tongyi LingmaMCP settings, add a server manually, paste the JSON below
Cherry StudioSettings, MCP servers, add: type STDIO, command uvx, arguments --python, 3.12, qlib-sync, mcp on separate lines
VS Code (Copilot agent mode).vscode/mcp.json: { "servers": { "qlib-sync": { "type": "stdio", "command": "uvx", "args": ["--python", "3.12", "qlib-sync", "mcp"] } } }
{ "mcpServers": { "qlib-sync": { "command": "uvx", "args": ["--python", "3.12", "qlib-sync", "mcp"] } } }

Menu names and file locations change between versions; check your client's MCP documentation if a path above has moved. Tested with Claude Code and OpenAI Codex CLI.

Web chat apps such as ChatGPT connect only to remote MCP servers over the internet, so they cannot start this local server.

Set QLIB_SYNC_DATA_DIR to use a dataset outside ~/.qlib/qlib_data/cn_data, and QLIB_SYNC_MIRROR to download through a mirror.

ToolDoes
cn_statusLocal latest date, pools, and whether an update is available
cn_updateInstall or update (safe to call: failures restore the previous data)
cn_health_checkStructure checks plus a real Qlib read
cn_get_pricesDaily bars for up to 20 symbols; real traded prices by default, adjusted on request
cn_list_poolMembers of csi300, csi500, and other pools on a date

Then ask things like "Is my A-share data current? What did Moutai close at over the last week?" Symbols accept 600519, SH600519, or 600519.SH.

Claude Code answering from the local dataset through qlib-sync: data freshness, Moutai closes, CSI 300 size

skills/qlib-sync/SKILL.md teaches an assistant when to update, how to read each failure, and the price conventions. It uses the open SKILL.md format that Claude, Codex, and other agents load from their skills folder; any assistant can also simply be pointed at the file.

Daily updates

A run that finds nothing new costs one small request, so schedule it daily. See docs/scheduling.md for cron and launchd examples.

Data and credits

All data comes from chenditc/investment_data (Apache-2.0). qlib-sync only downloads the public release; it does not host or redistribute data. Prices follow Qlib's convention: $close is adjusted and the real price is $close / $factor.

qlib-sync is an independent project, not affiliated with Microsoft or the Qlib team.

Supported: macOS and Linux, Python 3.10 to 3.12 (pyqlib does not publish wheels for newer versions yet; uvx picks a compatible Python automatically).

Development

uv venv && uv pip install -e ".[dev]"
.venv/bin/python -m pytest

License

MIT

Reviews

No reviews yet

Be the first to review this server!