Skip to main content
Glama

Boj Series List

boj_series_list
Read-onlyIdempotent

List or search the series in one Bank of Japan statistics database (code, name, unit, frequency, first and last period). Use to find the code for boj_series. Common db ids: MD02 money stock, MD01 monetary base, BP01 balance of payments, PR01 corporate goods price index. Very large databases return reason database_too_large_to_list.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "db": "MD02",
      "limit": 5,
      "query": "households"
    },
    "name": "boj_series_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
dbYesBOJ database id, e.g. 'MD02'.
limitNoMax series returned (default 25, max 100).
queryNoCase-insensitive text to match in the series code, name or category, e.g. 'households'.

Output Schema

NameRequiredDescriptionDefault
dbNoBOJ database id
codeNoSeries code
nameNoSeries name
foundNoWhether data was found
queryNoSearch text
reasonNonot_yet_published, series_not_found, no_observations, no_observations_in_range, database_not_found, no_matching_series, database_too_large_to_list
seriesNo
sourceNoPublisher and dataset
matchesNoMatching series
messageNoExplanation when found is false
returnedNoSeries returned
series_in_databaseNoSeries in the database

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The description adds genuine non-annotation context: the failure mode 'Very large databases return reason database_too_large_to_list', which tells the agent to expect a soft error rather than an exception. Return-field detail overlaps with the existing output schema, keeping it from a 5.

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 sentences, front-loaded with purpose, then the routing hint, then the db id cheat-sheet and the error caveat. Every sentence carries information an agent would otherwise have to discover by trial.

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 3-parameter read tool with full schema coverage and an output schema, this covers what remains: which database ids exist and what they hold, how query matching works, the cap on limit, and the known failure mode. Nothing an agent needs in order to call it correctly is 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?

Schema coverage is 100%, so baseline is 3, but the description adds real meaning beyond the schema by mapping db ids to their contents (MD02 money stock, MD01 monetary base, BP01 balance of payments, PR01 corporate goods price index) — the schema only offers 'MD02' as an example. It also implies limit/query behavior the schema already documents.

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?

Specific verb+resource: 'List or search the series in one Bank of Japan statistics database', with the returned fields enumerated (code, name, unit, frequency, first and last period). It also distinguishes itself from the sibling by stating 'Use to find the code for boj_series', so an agent can place it in the workflow without opening the schema.

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?

Gives an explicit use case and the downstream alternative ('Use to find the code for boj_series'), which is exactly the routing an agent needs. It stops short of stating when not to call it — e.g. that if the series code is already known, boj_series should be called directly — so 4 rather than 5.

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.