Skip to main content
Glama
qlib-sync

qlib-sync

cn_update

Idempotent

Install or update local China A-share data from the community release, with validation and automatic rollback to the previous dataset if verification or download fails.

Instructions

Install or update the local A-share data from the community release.

    Returns quickly when already current. Otherwise downloads about 550 MB, checks it with
    the dataset maintainers' own validator, and swaps it in; this takes roughly a minute.
    A release that cannot be verified is refused, and on any failure the previous data is
    restored. The result lists new trading days, listed/delisted symbols, and `verified`.
    

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "cn_update"
  }
}

Input Schema

NameRequiredDescriptionDefault
forceNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well past the annotations by disclosing download size (~550 MB), duration (~a minute), that validation uses the maintainers' own validator, that unverifiable releases are refused, and that any failure restores the previous data. That rollback disclosure is exactly the safety context an agent needs for a tool that swaps local data, and it is consistent with destructiveHint=false since the swap is reversible.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the verb and resource, then layers cost, verification, and failure behavior in a logical order. Slightly dense, but nearly every clause carries operational weight; only the result-field enumeration is arguably redundant given the output schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a one-parameter dataset-install mutation, the description covers cost, timing, validation, failure recovery, and even names result fields. With an output schema present, nothing essential is missing for an agent to call this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

One optional parameter (force) with 0% schema description coverage, and the description never names it directly. The 'returns quickly when already current' line implies the default short-circuits and that force must bypass that check, but the inference is left to the reader rather than stated.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific action and resource: install or update the local A-share dataset from the community release. This is clearly distinguishable from the sibling read tools (cn_get_prices, cn_status, cn_health_check) without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Implies when it is cheap to call ('Returns quickly when already current'), which effectively tells the agent it is safe to call without checking freshness first. However, it never states when to prefer this over alternatives or when a caller should skip it, and it gives no guidance on when to set force.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.