Skip to main content
Glama
qlib-sync

qlib-sync

cn_health_check

Read-only

Validates local Qlib China A-share data structure and runs a real Qlib read, returning ok status, errors, and checks to confirm dataset health.

Instructions

Validate the local data's structure and perform a real Qlib read; returns ok, errors, checks.

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_health_check"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuine value by disclosing that it performs a real Qlib read rather than a static inspection, which signals cost and a dependency on the Qlib engine. It does not say what happens on failure or whether the tool raises versus returning ok=false, leaving a real behavioral gap.

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?

One sentence, front-loaded with the primary verb and no filler. The trailing 'returns ok, errors, checks' is slightly cryptic given an output schema exists, but it is short enough not to burden the reader.

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

Completeness4/5

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

An output schema is present, so the description need not enumerate return values, and it appropriately only gestures at them. For a zero-parameter diagnostic tool the description covers what it does and one key behavioral trait; only failure-mode semantics are missing.

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

Parameters4/5

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

The tool takes zero parameters, so there is nothing for the description to disambiguate beyond what the schema already conveys. Baseline 4 applies; no parameter-level gaps exist.

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

Purpose4/5

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

The description names two concrete actions: validating the local data's structure and performing an actual Qlib read. That is a specific verb+resource pairing an agent can match to a diagnostic need. It stops short of distinguishing itself by name from the similar-sounding cn_status sibling, so it is clear but not fully differentiated.

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?

Usage is only implied: an agent can infer this is a pre-flight/diagnostic check to run before trusting the data pool. There is no explicit statement of when to prefer it over cn_status, nor any exclusion or prerequisite guidance (e.g. run before cn_get_prices).

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