Skip to main content
Glama

Taiwan Market Open Data (Unofficial)

Describe dataset

dataset.describe
Read-onlyIdempotent

Show one dataset's definition: id, source (TWSE or TAIFEX), summary, tags, and every field key with its Chinese description. The where, sort_by, fields and match parameters of dataset.get take these field keys. Reads the local catalog only, so it has no row counts or dates. 查看某個資料集的定義:代號、來源(證交所或期交所)、中文說明、分類標籤,以及每個欄位的鍵名與中文說明。dataset.get 的 where、sort_by、fields、match 都要用這裡的鍵名(例如 PEratio),不是中文說明。只讀本機目錄、不抓上游,所以不含資料筆數或最新日期。代號不存在時回 error,請先用 dataset.search 找。

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "dataset_id": "<dataset_id>"
    },
    "name": "dataset.describe"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataset_idYes來自 dataset.search 的資料集代號,例如 "exchangeReport/STOCK_DAY_ALL"。

Output Schema

NameRequiredDescriptionDefault
idYes
tagsYes
fieldsYes
sourceYes
summaryYes
source_noteYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / source_note
      Added value: +{
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "id",
      -  "source",
      -  "summary",
      -  "tags",
      -  "fields"
      -]New value: +[
      +  "id",
      +  "source",
      +  "summary",
      +  "tags",
      +  "fields",
      +  "source_note"
      +]
  2. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, closed-world, non-destructive), and the description adds value beyond them: it reads the local catalog only and does not fetch upstream, so results carry no row counts or latest dates. It also discloses that an unknown dataset_id returns an error, which is concrete failure behavior not encoded in the annotations.

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?

The content is dense, front-loaded with the return shape, and every English sentence carries usage or constraint information. The main inefficiency is that the entire content is repeated verbatim in Chinese, which doubles length without adding information for a single-language reader, though it may be an intentional bilingual convention.

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 single-parameter, read-only lookup with an output schema, nothing an agent needs is missing: what it returns, where the data comes from, what it deliberately excludes, how to obtain a valid id, and what happens on failure are all stated.

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?

Schema coverage is 100%, so the baseline is 3, but the description adds cross-tool meaning: the field keys shown here are exactly the keys required by dataset.get's where, sort_by, fields and match parameters, with an inline example ('PEratio') warning against using the Chinese labels. That is semantic value the schema alone does not convey.

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?

The definition uses a specific verb and resource ('Show one dataset's definition') and then enumerates exactly what is returned: id, source (TWSE or TAIFEX), summary, tags, and every field key with its Chinese description. It is clearly distinguishable from dataset.get (which consumes these field keys) and from dataset.search (suggested to resolve an id first).

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

Usage Guidelines4/5

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

It tells the agent to resolve the id via dataset.search before calling, and it explains the downstream relationship to dataset.get by stating that where/sort_by/fields/match all take the keys shown here. There is no explicit 'when not to use' clause, but the routing to the two sibling tools is clear.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.