Skip to main content
Glama

read_guide

Consult the database maintainer's guide, catalog, and unresolved data issues before MICS or cross-dataset/table joins to verify cleaning flags, missing-value codes, harmonized variables, and join conventions.

Instructions

读出数据库自带的使用指南(public._guide)、表目录(public._catalog)和未解决的数据问题(public.data_issues)。 ★ 这是数据库维护者手写的权威文档,包含跨数据集比较的关键陷阱:哪些列是清洗过的(CP 前缀)、缺失值哨兵编码、不同年代数据集的编码差异、表之间的连接键和坑。 涉及 MICS 数据、或者要做跨数据集/跨国比较、或者要连接多张表时,先调这个工具读一遍。它和其他工具的推断性说明冲突时,以它为准。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionNo只读某一章节,如 join_conventions / coding_conventions / cp_prefix / harmonized_variables。省略则返回全部

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

No annotations are provided, so the description must carry the behavioral burden. It clearly implies a read-only operation ('读出') and discloses that it returns authoritative handwritten documentation containing pitfalls, and that it takes precedence over other tools. It does not explicitly state side-effect safety or permissions, leaving a minor gap.

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

Conciseness5/5

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

Three tightly written sentences: first states what it reads, second explains its value and contents, third gives usage conditions and precedence. It is front-loaded and free of redundancy.

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?

With an output schema present, return values are covered. The description supplies purpose, content, usage triggers, and precedence, which is complete for a read-only guide tool with one optional parameter.

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?

Schema description coverage is 100%, and the schema itself documents the single optional 'section' parameter with examples. The description adds no additional syntax or format details for the parameter, so baseline 3 is appropriate.

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 verb (读出/read out) and three specific resources (public._guide, public._catalog, public._data_issues). It distinguishes itself from sibling metadata tools by declaring itself the authoritative handwritten source and specifying it should be consulted first for MICS, cross-dataset, and join work.

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?

Explicitly states when to call it (MICS data, cross-dataset/cross-country comparisons, joining multiple tables) and instructs to call it first. It also establishes precedence over other tools' inferential descriptions. However, it does not specify when not to use it or name specific alternative tools, so it falls short of the top score.

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