# e-stat-dashboard-mcp

統計ダッシュボードの公式APIを参照する読み取り専用のMCPサーバーです。Python 3.12以上とuv（0.13.4で検証）を使います。上流APIのキー設定は不要です。

## MCPクライアント設定

GitHubリポジトリへのアクセス権がある環境でクローンします。

```sh
git clone https://github.com/koizumikento/e-stat-dashboard-mcp.git
cd e-stat-dashboard-mcp
uv sync --locked
```

クライアントの設定に、クローン先の絶対パスを指定します。

```json
{
  "mcpServers": {
    "e-stat-dashboard-mcp": {
      "command": "uv",
      "args": ["--directory", "/absolute/path/to/e-stat-dashboard-mcp", "run", "--locked", "e-stat-dashboard-mcp"]
    }
  }
}
```

## ツール

| ツール | 用途 |
| --- | --- |
| `search_indicators` | 指標名から系列コードを検索 |
| `get_indicator_data` | 系列コード、任意の地域・周期で統計値を取得 |

系列名を検索し、系列コードで数値を取得します。1回の返却件数は最大100件で、取得結果の続きはoffsetで指定します。

## CLI

```sh
uv run e-stat-dashboard-mcp search-indicators --query "総人口" --limit 1
uv run e-stat-dashboard-mcp get-indicator-data --indicator-code 0201010000000010000 --limit 1
```

結果は標準出力にUTF-8のJSONで出力します。コマンドの引数は `uv run e-stat-dashboard-mcp search-indicators --help` で確認できます。

## Pythonライブラリ

パッケージをインストールしたPython環境で、下記の非同期関数を直接呼び出せます。

```python
import asyncio

from e_stat_dashboard_mcp import search_indicators

result = asyncio.run(search_indicators(query="総人口", limit=1))
print(result)
```

公開関数 `search_indicators`、`get_indicator_data` を利用できます。イベントループがある環境では、関数を直接 `await` します。

## 出典と利用条件

コードはMIT Licenseです。取得するデータの権利と利用条件は、API提供元と各データ提供機関の定めに従います。[公式API仕様](https://dashboard.e-stat.go.jp/static/api) · [利用案内](https://dashboard.e-stat.go.jp/static/api)

このサービスは、統計ダッシュボードのAPI機能を使用していますが、サービスの内容は国によって保証されたものではありません。

## 開発

```sh
uv sync --locked
uv run ruff check .
uv run ty check
uv run pytest
uv build
```