`boj_series_list`

Pack: boj · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/boj_series_list for the schema, then POST the same URL with its arguments for the data.

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.

Parameters

Name	Type	Required	Description
`db`	string	yes	BOJ database id, e.g. ‘MD02’.
`query`	string	no	Case-insensitive text to match in the series code, name or category, e.g. ‘households’.
`limit`	number	no	Max series returned (default 25, max 100).

Example call

Arguments

{
  "db": "MD02",
  "query": "households",
  "limit": 5
}

curl

curl -X POST https://gateway.pipeworx.io/boj/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"boj_series_list","arguments":{"db":"MD02","query":"households","limit":5}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('boj_series_list', {
  "db": "MD02",
  "query": "households",
  "limit": 5
});

Response shape

Field	Type	Description
`found`	boolean \| null	Whether data was found
`reason`	string \| null	not_yet_published, series_not_found, no_observations, no_observations_in_range, database_not_found, no_matching_series, database_too_large_to_list
`db`	string \| null	BOJ database id
`code`	string \| null	Series code
`name`	string \| null	Series name
`message`	string \| null	Explanation when found is false
`source`	string \| null	Publisher and dataset
`query`	string \| null	Search text
`series_in_database`	number \| null	Series in the database
`matches`	number \| null	Matching series
`returned`	number \| null	Series returned
`series`	array

Full JSON Schema

{
  "type": "object",
  "additionalProperties": true,
  "properties": {
    "found": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Whether data was found"
    },
    "reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "not_yet_published, series_not_found, no_observations, no_observations_in_range, database_not_found, no_matching_series, database_too_large_to_list"
    },
    "db": {
      "type": [
        "string",
        "null"
      ],
      "description": "BOJ database id"
    },
    "code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Series code"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Series name"
    },
    "message": {
      "type": [
        "string",
        "null"
      ],
      "description": "Explanation when found is false"
    },
    "source": {
      "type": [
        "string",
        "null"
      ],
      "description": "Publisher and dataset"
    },
    "query": {
      "type": [
        "string",
        "null"
      ],
      "description": "Search text"
    },
    "series_in_database": {
      "type": [
        "number",
        "null"
      ],
      "description": "Series in the database"
    },
    "matches": {
      "type": [
        "number",
        "null"
      ],
      "description": "Matching series"
    },
    "returned": {
      "type": [
        "number",
        "null"
      ],
      "description": "Series returned"
    },
    "series": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A series",
        "properties": {
          "code": {
            "type": [
              "string",
              "null"
            ],
            "description": "Series code"
          },
          "name": {
            "type": [
              "string",
              "null"
            ],
            "description": "Series name"
          },
          "unit": {
            "type": [
              "string",
              "null"
            ],
            "description": "Unit"
          },
          "frequency": {
            "type": [
              "string",
              "null"
            ],
            "description": "Frequency"
          },
          "category": {
            "type": [
              "string",
              "null"
            ],
            "description": "Category"
          },
          "first_period": {
            "type": [
              "string",
              "null"
            ],
            "description": "First period"
          },
          "last_period": {
            "type": [
              "string",
              "null"
            ],
            "description": "Last period"
          },
          "last_update": {
            "type": [
              "string",
              "null"
            ],
            "description": "Last update"
          }
        },
        "additionalProperties": true
      }
    }
  }
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

{
  "mcpServers": {
    "pipeworx": {
      "url": "https://pipeworx.io/mcp"
    }
  }
}

Connect to just the boj pack

{
  "mcpServers": {
    "boj": {
      "url": "https://gateway.pipeworx.io/boj/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

boj_series_list