File size: 60,282 Bytes
2f203f5 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 | """MCP Tools for the Data360 server.
Thin wrapper layer that registers API functions as MCP tools with optimized signatures,
concise docstrings to reduce token context bloat, and validation schemas.
"""
import json
import os
import threading
from typing import Any, Literal, Optional
import pydantic_core
from fastmcp.apps import AppConfig
from fastmcp.exceptions import ToolError
from fastmcp.tools import ToolResult
from fastmcp.tools.tool import Tool
from mcp.types import TextContent
from data360 import api as data360_api
from data360 import providers as data360_providers
from data360 import visualization as data360_viz
from data360 import viz_config as data360_viz_config
from ._server_definition import mcp
from .tool_spans import instrument_mcp_tool
# ---------------------------------------------------------------------------
# Serializer for aggregation tools
# ---------------------------------------------------------------------------
def _compact_aggregation_serializer(data: Any) -> str:
"""Compact serializer for aggregation tool responses.
Calls ``to_compact()`` on the response model if available, producing a
token-efficient JSON representation while preserving all PCN claim_ids
for data provenance verification.
"""
if hasattr(data, "to_compact"):
return json.dumps(data.to_compact(), separators=(",", ":"))
return pydantic_core.to_json(data, fallback=str).decode()
def _normalize_disaggregation_filters(filters: dict[str, Any] | None) -> dict[str, str | None] | None:
"""Normalize user-provided disaggregation filters.
Converts list values (e.g., ["F", "M"]) to comma-separated strings (e.g., "F,M")
to conform to the underlying API support while remaining type-flexible for LLM callers.
"""
if filters is None:
return None
normalized = {}
for k, v in filters.items():
if v is None:
normalized[k] = None
elif isinstance(v, list):
normalized[k] = ",".join(str(item).strip() for item in v if item is not None)
else:
normalized[k] = str(v)
return normalized
# ---------------------------------------------------------------------------
# Tool Wrapper Functions
# ---------------------------------------------------------------------------
async def _search_indicators(
query: str | None = None,
required_country: str | None = None,
limit: int = 5,
offset: int = 0,
queries: list[str] | None = None,
query_groups: list[dict[str, Any]] | None = None,
result_layout: str = "merged",
dedupe: bool = True,
database: str | None = None,
) -> Any:
"""Search for Data360 indicators with enriched metadata for selection.
Use when the user asks for data on a development topic (e.g. GDP, poverty, education).
Default to using the single `query` parameter for any single topic/indicator search. Use the `queries` or `query_groups` parameters ONLY when the request involves multiple topics or scopes (2 or more).
Provide exactly one of `query`, `queries`, or `query_groups`. One of these is strictly required.
### Parameter Selection Decision Tree (CRITICAL):
1. **Exactly 1 Topic** (e.g., "life expectancy" or "mortality rate") for any number of countries → you MUST use the single `query` parameter + `required_country`. Do NOT use `queries` with only one element, as it will fail. Do NOT combine multiple topics with 'and' or 'or' in `query` (e.g. do NOT use query="GDP and inflation").
2. **Multiple Topics, Same Country/Countries** (e.g., "life expectancy and GDP per capita" for Japan) → you MUST use the `queries` list parameter (e.g. `queries=["life expectancy", "GDP per capita"]`) + `required_country`. Do NOT make multiple tool calls. Do NOT pass multiple topics as a single query string (e.g., query="life expectancy and GDP per capita" is invalid).
3. **Different Topics targeting Different Countries** (e.g., "life expectancy for Japan, but GDP and mortality rate for Korea") → you MUST use the `query_groups` parameter. Do NOT use `queries`.
Args:
query: Single topic query (e.g. "unemployment"). Use ONLY for a single topic. Do NOT combine multiple topics with 'and' or 'or' (e.g. do NOT use query="population and life expectancy"). Avoid special characters like parentheses () or dollar signs $. Example: 'GDP per capita'.
required_country: Semicolon-separated ISO country codes (e.g. "KEN;USA"). Shared across all queries in 'query' or 'queries'. Consider calling `data360_expand_country_group` to find country codes in regional/income groups, or `data360_find_codelist_value` to resolve country names.
limit: Max indicators per query (default 5).
offset: Offset for pagination.
queries: List of topics for multi-topic search (must contain at least 2 non-empty search strings). Use ONLY when 2 or more topics target the SAME countries/geographic scope (e.g. ['GDP per capita', 'inflation rate']).
query_groups: Grouped queries with specific country scopes. Use ONLY when different topics/queries target different country scopes. Example: [{'queries': ['life expectancy'], 'country': 'JPN'}, {'queries': ['GDP per capita'], 'country': 'KOR'}].
result_layout: Mode to return results: "merged" (flat, deduped list of indicators) or "by_query" (indicators grouped by search query).
dedupe: De-duplicate indicators across query results.
database: Optional database name or ID to filter search results (e.g. "wdi", "wgi", "World Development Indicators"). Multiple databases can be queried at once by separating them with a semicolon (e.g. "pip; lpgd; sgi").
"""
# Robustness fallback: if queries is passed as a list of exactly 1 item,
# normalize it to a single query parameter to prevent validation failure.
if queries is not None:
clean_queries = [q.strip() for q in queries if q and q.strip()]
if len(clean_queries) == 1:
if not query:
query = clean_queries[0]
queries = None
return await data360_api.search(
query=query,
required_country=required_country,
limit=limit,
offset=offset,
queries=queries,
query_groups=query_groups,
result_layout=result_layout,
dedupe=dedupe,
database=database,
)
async def _search_datasets(
query: str,
limit: int = 10,
offset: int = 0,
) -> Any:
"""Search for Data360 datasets matching a query.
Use when the user asks for dataset details, catalogs, or source databases (e.g. "Findex", "WDI").
Args:
query: Topic or dataset search term (e.g. "findex"). Avoid special characters like parentheses () or dollar signs $ as they cause search failures.
limit: Max datasets to return (default 10).
offset: Offset for pagination.
"""
return await data360_api.search_datasets(
query=query,
limit=limit,
offset=offset,
)
async def _get_metadata(
database_id: str,
indicator_id: str,
select_fields: list[str] | None = None,
fetch_disaggregation: bool = True,
required_country: str | None = None,
) -> Any:
"""Get metadata and disaggregation options for a Data360 indicator.
Use when you need detailed methodology, source notes, or limitations for an indicator.
Ensure the database ID and the indicator ID are already in context (e.g., from `data360_search_indicators`) before using this tool. Do not guess or hallucinate these IDs.
Args:
database_id: Database identifier (e.g., "WB_WDI").
indicator_id: Indicator ID (e.g., "WB_WDI_NY_GDP_PCAP_KD").
select_fields: Optional metadata fields to return (e.g., ["methodology", "relevance"]).
fetch_disaggregation: Whether to include disaggregation options.
required_country: Semicolon-separated ISO country codes to check coverage.
"""
return await data360_api.get_metadata(
database_id=database_id,
indicator_id=indicator_id,
select_fields=select_fields,
fetch_disaggregation=fetch_disaggregation,
required_country=required_country,
)
async def _get_data(
database_id: str,
indicator_id: str,
country_code: str | None = None,
disaggregation_filters: dict[str, Any] | None = None,
start_year: int | None = None,
end_year: int | None = None,
limit: int = 50,
offset: int = 0,
ref_area_filter: Literal["none", "member_economies_only"] = "member_economies_only",
year: int | None = None,
) -> Any:
"""Retrieve indicator observations from the Data360 API.
Use when you need actual numeric values (OBS_VALUE) for specific countries and years.
Ensure the database ID and the indicator ID are already in context before using this tool. Do not guess or hallucinate these IDs.
Call `data360_get_disaggregation` first to find available years and breakdowns for the `disaggregation_filters`.
Args:
database_id: Database identifier (e.g., "WB_WDI").
indicator_id: Indicator ID (e.g., "WB_WDI_NY_GDP_PCAP_KD").
country_code: Semicolon-separated ISO country codes (e.g. "KEN;USA").
disaggregation_filters: Optional dimension filters. Values must be strings or null. Call `data360_get_disaggregation` first to find valid options.
start_year: Start year (inclusive). Defaults to last 5 years if both bounds omitted;
if only end_year is set, defaults to a 5-year window ending at end_year.
end_year: End year (inclusive). See start_year for partial-bound defaults.
limit: Max records per page (default 50, max 100).
offset: Number of records to skip for pagination.
ref_area_filter: Filter mode: "member_economies_only" (default) or "none".
year: Specific single year to retrieve data for. Maps internally to start_year and end_year.
"""
if year is not None:
if start_year is None:
start_year = year
if end_year is None:
end_year = year
norm_filters = _normalize_disaggregation_filters(disaggregation_filters)
return await data360_api.get_data(
database_id=database_id,
indicator_id=indicator_id,
country_code=country_code,
disaggregation_filters=norm_filters,
start_year=start_year,
end_year=end_year,
limit=limit,
offset=offset,
ref_area_filter=ref_area_filter,
)
async def _get_disaggregation(
database_id: str,
indicator_id: str,
required_country: str | None = None,
) -> dict[str, Any]:
"""Get valid filter values and disaggregation options for an indicator.
Use to find available dimensions (e.g., SEX, AGE) and years before querying data or charts.
Ensure the database ID and the indicator ID are already in context before using this tool. Do not guess or hallucinate these IDs.
Args:
database_id: Database identifier (e.g., "WB_WDI").
indicator_id: Indicator ID (e.g., "WB_WDI_NY_GDP_PCAP_KD").
required_country: Semicolon-separated ISO country codes to check coverage.
"""
return await data360_api.get_disaggregation(
database_id=database_id,
indicator_id=indicator_id,
required_country=required_country,
)
async def _find_codelist_value(
codelist_type: str, query: str, limit: int = 5
) -> list[dict[str, Any]]:
"""Resolve user-friendly names to API dimension codes.
Use when you need to find codes for country names, sex, age, urbanisation, etc.
Args:
codelist_type: Dimension name (e.g. "REF_AREA", "SEX", "AGE", "URBANISATION").
query: Search term (e.g. "Kenya", "female").
limit: Max results to return (default 5).
"""
return await data360_providers.find_codelist_value(
codelist_type=codelist_type, query=query, limit=limit
)
async def _list_indicators(database_id: str) -> list[str]:
"""Get all indicator IDs for a specific database.
Use when you need the full list of indicator IDs for a dataset.
Args:
database_id: The database identifier (e.g., "WB_WDI").
"""
return await data360_api.get_indicators(database_id=database_id)
async def _get_data_api_url(
database_id: str,
indicator_id: str,
country_code: str | None = None,
start_year: int | None = None,
end_year: int | None = None,
disaggregation_filters: dict[str, Any] | None = None,
year: int | None = None,
) -> str:
"""Generate the raw Data360 API URL for an indicator request.
Low-level tool: use only when the caller specifically asks for the URL.
Ensure the database ID and the indicator ID are already in context before using this tool. Do not guess or hallucinate these IDs.
Args:
database_id: Database identifier (e.g. "WB_WDI").
indicator_id: Indicator ID (e.g. "WB_WDI_NY_GDP_PCAP_KD").
country_code: Semicolon-separated ISO country codes.
start_year: Start year (inclusive). Defaults to last 5 years if omitted.
end_year: End year (inclusive). Defaults to current year if omitted.
disaggregation_filters: Optional dimension filters.
year: Specific single year to generate the URL for. Maps internally to start_year and end_year.
"""
if year is not None:
if start_year is None:
start_year = year
if end_year is None:
end_year = year
norm_filters = _normalize_disaggregation_filters(disaggregation_filters)
return await data360_api.get_data_api_url(
database_id=database_id,
indicator_id=indicator_id,
country_code=country_code,
start_year=start_year,
end_year=end_year,
disaggregation_filters=norm_filters,
)
# ---------------------------------------------------------------------------
# Bundled Vega library cache (thread-safe, loaded once on first use)
# ---------------------------------------------------------------------------
_vega_libs_lock = threading.Lock()
_vega_libs_cache: tuple[str, str, str, str] | None = None
def get_cached_vega_libs() -> tuple[str, str, str, str]:
"""Load and cache local Vega library scripts from static/libs (thread-safe)."""
global _vega_libs_cache
if _vega_libs_cache is not None:
return _vega_libs_cache
with _vega_libs_lock:
if _vega_libs_cache is not None: # double-check after acquiring lock
return _vega_libs_cache
from pathlib import Path
import logging
libs_dir = (
Path(__file__).resolve().parent.parent.parent.parent / "static" / "libs"
)
try:
vega_js = (libs_dir / "vega.js").read_text(encoding="utf-8")
vega_lite_js = (libs_dir / "vega-lite.js").read_text(encoding="utf-8")
vega_embed_js = (libs_dir / "vega-embed.js").read_text(encoding="utf-8")
vega_interp_js = (libs_dir / "vega-interpreter.js").read_text(
encoding="utf-8"
)
except Exception as e:
logging.getLogger("data360").warning(
"Failed to load local Vega library scripts: %s", e
)
vega_js = vega_lite_js = vega_embed_js = vega_interp_js = ""
_vega_libs_cache = (vega_js, vega_lite_js, vega_embed_js, vega_interp_js)
return _vega_libs_cache
# ---------------------------------------------------------------------------
# Markdown summary helper (text content block for viz ToolResults)
# ---------------------------------------------------------------------------
def _make_text_summary(
spec: "dict[str, Any] | None",
strategy: str,
reason: str,
warning: str | None = None,
subtitle_line: str | None = None,
source_line: str | None = None,
url: str | None = None,
) -> str:
"""Build a markdown summary table from a Vega-Lite spec for the text content block."""
import pandas as pd
lines: list[str] = []
if warning:
lines.append(f"### Warning\n{warning}\n")
lines.append(f"### Data Summary ({strategy})")
lines.append(reason)
if subtitle_line:
lines.append(f"*{subtitle_line}*")
lines.append("")
data_rows: list[dict] = []
if isinstance(spec, dict):
data_rows = spec.get("data", {}).get("values", [])
if data_rows:
try:
df = pd.DataFrame(data_rows)
# Reorder: put time/area columns first
cols = list(df.columns)
for p in reversed(
["TIME_PERIOD", "time_period", "REF_AREA", "ref_area"]
):
if p in cols:
cols.remove(p)
cols.insert(0, p)
df = df[cols]
headers = [c.replace("_", " ").title() for c in df.columns]
lines.append("| " + " | ".join(headers) + " |")
lines.append("| " + " | ".join(["---"] * len(df.columns)) + " |")
for _, row in df.iterrows():
vals = []
for col in df.columns:
v = row[col]
if v is None or (isinstance(v, float) and pd.isna(v)):
vals.append("")
elif isinstance(v, float):
vals.append(f"{v:,.2f}")
else:
vals.append(str(v))
lines.append("| " + " | ".join(vals) + " |")
except Exception:
lines.append("No tabular data available.")
else:
lines.append("No data available.")
if source_line:
lines.append(f"\n*{source_line}*")
if url:
lines.append(f"\n*Vega-Lite Spec URL:* {url}")
return "\n".join(lines)
async def _get_viz_spec(
database_id: str,
indicator_id: str,
country_code: str | None = None,
start_year: int | None = None,
end_year: int | None = None,
disaggregation_filters: dict[str, Any] | None = None,
chart_type: str | None = None,
relevant_fields: list[str] | None = None,
custom_constraints: list[str] | None = None,
use_default_constraints: bool = True,
chart_title: str | dict | None = None,
series_labels: dict[str, str] | None = None,
strategy_override: str | None = None,
year: int | None = None,
) -> ToolResult:
"""Generate a Vega-Lite chart from a single Data360 indicator.
Use when the user requests a chart or plot for a single indicator.
Ensure the database ID and the indicator ID are already in context before using this tool. Do not guess or hallucinate these IDs.
Call `data360_get_disaggregation` first to find available years and breakdowns for the `disaggregation_filters`.
Args:
database_id: Database identifier (e.g. "WB_WDI").
indicator_id: Indicator ID (e.g. "WB_WDI_NY_GDP_PCAP_KD").
country_code: Semicolon-separated ISO country codes (e.g. "KEN;USA").
start_year: Start year (inclusive). Defaults to last 5 years if omitted.
end_year: End year (inclusive). Defaults to current year if omitted.
disaggregation_filters: Optional dimension filters.
chart_type: Optional chart type suggestion. If omitted (recommended), the routing engine automatically determines the optimal chart type and strategy based on the data profile. Do not specify this argument unless the user explicitly requested a specific chart type.
relevant_fields: Fields to include in visual encodings.
custom_constraints: Custom Draco design rules.
use_default_constraints: Whether to apply default Draco design constraints.
chart_title: A concise, human-synthesized title summarizing the data insight (e.g. 'Renewable Energy Share in South Asia (2020)'). Prefer clean, natural phrasing instead of raw long indicator names.
series_labels: Rename dimension codes for legend (e.g. {"WGI_EST": "Estimate"}).
strategy_override: Explicitly force a chart strategy (e.g. "stacked_bar", "temporal_single").
year: Specific single year to generate the chart for. Maps internally to start_year and end_year.
"""
if year is not None:
if start_year is None:
start_year = year
if end_year is None:
end_year = year
norm_filters = _normalize_disaggregation_filters(disaggregation_filters)
res = await data360_viz.get_viz_spec(
database_id=database_id,
indicator_id=indicator_id,
country_code=country_code,
start_year=start_year,
end_year=end_year,
disaggregation_filters=norm_filters,
chart_type=chart_type,
relevant_fields=relevant_fields,
custom_constraints=custom_constraints,
use_default_constraints=use_default_constraints,
chart_title=chart_title,
series_labels=series_labels,
strategy_override=strategy_override,
)
if res.get("error"):
raise ToolError(res["error"])
url = res.get("url")
strategy = res.get("strategy") or "unknown"
reason = res.get("reason") or ""
warning = res.get("warning")
source_line = res.get("source_line")
subtitle_line = res.get("subtitle_line")
# Prefer the spec already carried in the result dict (populated by _ok() in
# visualization.py). The disk-reload below is a fallback for callers that
# do not propagate the spec (e.g. when the chart URL points to an external
# charts API rather than the local static file server).
spec: dict | None = res.get("spec") or None
if spec is None and url:
try:
spec_id = url.split("/")[-1].replace("_vega.json", "")
if os.environ.get("PYTEST_CURRENT_TEST"):
specs_dir = os.path.join(os.getcwd(), "static", "viz_specs")
else:
server_dir = os.path.dirname(os.path.abspath(__file__))
project_root = os.path.abspath(os.path.join(server_dir, "..", "..", ".."))
specs_dir = os.path.join(project_root, "static", "viz_specs")
vega_path = os.path.join(specs_dir, f"{spec_id}_vega.json")
if os.path.exists(vega_path):
with open(vega_path, "r") as f:
spec = json.load(f)
except Exception:
pass
text_summary = _make_text_summary(
spec=spec,
strategy=strategy,
reason=reason,
warning=warning,
source_line=source_line,
subtitle_line=subtitle_line,
url=url,
)
structured = {
"spec": spec,
"strategy": strategy,
"url": url,
"error": None,
"warning": warning,
"reason": reason,
"source_line": source_line,
"subtitle_line": subtitle_line,
}
return ToolResult(
content=[
TextContent(type="text", text=json.dumps(structured)),
TextContent(type="text", text=text_summary),
],
structured_content=structured,
)
async def _get_multi_indicator_viz_spec(
indicator_ids: list[dict[str, str]] | None = None,
country_code: str | None = None,
start_year: int | None = None,
end_year: int | None = None,
disaggregation_filters: dict[str, Any] | None = None,
chart_type: str | None = None,
chart_title: str | dict | None = None,
series_labels: dict[str, str] | None = None,
strategy_override: str | None = None,
year: int | None = None,
) -> ToolResult:
"""Generate a Vega-Lite chart comparing multiple Data360 indicators.
Use when you need to compare 2–4 indicators (e.g. via scatterplot or dual-axis line chart).
Ensure the database IDs and indicator IDs are already in context before using this tool. Do not guess or hallucinate these IDs.
Args:
indicator_ids: List of database/indicator dicts, e.g. [{"database_id": "WB_WDI", "indicator_id": "..."}].
country_code: Semicolon-separated ISO country codes (e.g. "KEN;USA").
start_year: Start year (inclusive). Defaults to last 5 years if omitted.
end_year: End year (inclusive). Defaults to current year if omitted.
disaggregation_filters: Optional dimension filters.
chart_type: Optional chart type suggestion. If omitted (recommended), the routing engine automatically determines the optimal chart type and strategy based on the data profile. Do not specify this argument unless the user explicitly requested a specific chart type.
chart_title: A concise, human-synthesized title summarizing the data insight (e.g. 'Renewable Energy Share in South Asia (2020)'). Prefer clean, natural phrasing instead of raw long indicator names.
series_labels: Rename dimension codes for legend.
strategy_override: Explicitly force a chart strategy (e.g. "stacked_bar", "vconcat_panels").
year: Specific single year to compare indicators for. Maps internally to start_year and end_year.
"""
if year is not None:
if start_year is None:
start_year = year
if end_year is None:
end_year = year
norm_filters = _normalize_disaggregation_filters(disaggregation_filters)
res = await data360_viz.get_multi_indicator_viz_spec(
indicator_ids=indicator_ids,
country_code=country_code,
start_year=start_year,
end_year=end_year,
disaggregation_filters=norm_filters,
chart_type=chart_type,
chart_title=chart_title,
series_labels=series_labels,
strategy_override=strategy_override,
)
if res.get("error"):
raise ToolError(res["error"])
url = res.get("url")
strategy = res.get("strategy") or "unknown"
reason = res.get("reason") or ""
warning = res.get("warning")
source_line = res.get("source_line")
subtitle_line = res.get("subtitle_line")
# Prefer the spec already carried in the result dict (populated by _ok() in
# visualization.py). The disk-reload below is a fallback for callers that
# do not propagate the spec (e.g. when the chart URL points to an external
# charts API rather than the local static file server).
spec: dict | None = res.get("spec") or None
if spec is None and url:
try:
spec_id = url.split("/")[-1].replace("_vega.json", "")
if os.environ.get("PYTEST_CURRENT_TEST"):
specs_dir = os.path.join(os.getcwd(), "static", "viz_specs")
else:
server_dir = os.path.dirname(os.path.abspath(__file__))
project_root = os.path.abspath(os.path.join(server_dir, "..", "..", ".."))
specs_dir = os.path.join(project_root, "static", "viz_specs")
vega_path = os.path.join(specs_dir, f"{spec_id}_vega.json")
if os.path.exists(vega_path):
with open(vega_path, "r") as f:
spec = json.load(f)
except Exception:
pass
text_summary = _make_text_summary(
spec=spec,
strategy=strategy,
reason=reason,
warning=warning,
source_line=source_line,
subtitle_line=subtitle_line,
url=url,
)
structured = {
"spec": spec,
"strategy": strategy,
"url": url,
"error": None,
"warning": warning,
"reason": reason,
"source_line": source_line,
"subtitle_line": subtitle_line,
}
return ToolResult(
content=[
TextContent(type="text", text=json.dumps(structured)),
TextContent(type="text", text=text_summary),
],
structured_content=structured,
)
def _get_supported_chart_types() -> str:
"""Return supported chart types and their data requirements as JSON.
**DEPRECATED**: Read the ``data360://viz/chart-grammar`` resource instead.
This tool is preserved for backward compatibility.
"""
import json
result = data360_viz.get_supported_chart_types()
parsed = json.loads(result)
parsed["_deprecation_notice"] = (
"This tool is deprecated. Read the data360://viz/chart-grammar resource "
"for comprehensive chart strategy rules. The data_profile in every viz "
"response now includes per-indicator ranges and scale compatibility."
)
return json.dumps(parsed, indent=2)
async def _expand_country_group(
group_code: str,
) -> dict[str, Any]:
"""Expand a REF_AREA group code into its constituent country codes.
Use when you need individual country codes for a regional or income group code (e.g. "SAS").
Args:
group_code: The group code to expand (e.g. "SAS" for South Asia, "LIC" for Low Income).
"""
return await data360_providers.expand_country_group(group_code=group_code)
async def _summarize_data(
database_id: str,
indicator_id: str,
country_code: str | None = None,
disaggregation_filters: dict[str, Any] | None = None,
start_year: int | None = None,
end_year: int | None = None,
group_by: list[str] | None = None,
) -> Any:
"""Compute summary statistics for indicator data, grouped by dimensions.
Use when the user asks about trends, changes over time, or general statistical summaries.
Ensure the database ID and the indicator ID are already in context before using this tool. Do not guess or hallucinate these IDs.
Args:
database_id: Database identifier (e.g. "WB_WDI").
indicator_id: Indicator ID (e.g. "WB_WDI_NY_GDP_PCAP_KD").
country_code: Semicolon-separated ISO country codes (e.g. "KEN;USA").
disaggregation_filters: Optional dimension filters.
start_year: Start year (inclusive). Defaults to last 5 years if omitted.
end_year: End year (inclusive). Defaults to current year if omitted.
group_by: Dimensions to group by (default is ["ref_area"]).
"""
norm_filters = _normalize_disaggregation_filters(disaggregation_filters)
return await data360_api.summarize_data(
database_id=database_id,
indicator_id=indicator_id,
country_code=country_code,
disaggregation_filters=norm_filters,
start_year=start_year,
end_year=end_year,
group_by=group_by,
)
async def _rank_countries(
database_id: str,
indicator_id: str,
country_group: str | None = None,
country_codes: str | None = None,
year: int | None = None,
order: Literal["desc", "asc"] = "desc",
top_n: int = 10,
disaggregation_filters: dict[str, Any] | None = None,
rank_universe: Literal["explicit", "all_member_economies"] = "explicit",
) -> Any:
"""Rank countries by indicator value for a specific year.
Use when asked to rank countries, find leaderboards, or query top/bottom performing economies.
Ensure the database ID and the indicator ID are already in context before using this tool. Do not guess or hallucinate these IDs.
Args:
database_id: Database identifier (e.g. "WB_WDI").
indicator_id: Indicator ID (e.g. "WB_WDI_NY_GDP_PCAP_KD").
country_group: Code of region/income group (e.g. "SAS").
country_codes: Semicolon-separated ISO country codes (e.g. "KEN;USA;NGA").
year: Year for ranking. If omitted, selected automatically based on coverage.
order: Sort order: "desc" (default, highest first) or "asc" (lowest first).
top_n: Number of ranked entries to return.
disaggregation_filters: Optional dimension filters.
rank_universe: "explicit" (default, uses codes/group) or "all_member_economies" (world).
"""
norm_filters = _normalize_disaggregation_filters(disaggregation_filters)
return await data360_api.rank_countries(
database_id=database_id,
indicator_id=indicator_id,
country_group=country_group,
country_codes=country_codes,
year=year,
order=order,
top_n=top_n,
disaggregation_filters=norm_filters,
rank_universe=rank_universe,
)
async def _compare_countries(
database_id: str,
indicator_id: str,
country_codes: str,
year: int | None = None,
include_time_series: bool = False,
start_year: int | None = None,
end_year: int | None = None,
disaggregation_filters: dict[str, Any] | None = None,
) -> Any:
"""Compare an indicator across multiple countries (2 to 8).
Use when asked to compare specific countries or find gaps/convergence between them.
Ensure the database ID and the indicator ID are already in context before using this tool. Do not guess or hallucinate these IDs.
Call `data360_get_disaggregation` first to find available years and breakdowns for the `disaggregation_filters`.
Args:
database_id: Database identifier (e.g. "WB_WDI").
indicator_id: Indicator ID (e.g. "WB_WDI_NY_GDP_PCAP_KD").
country_codes: Semicolon-separated ISO country codes (e.g. "KEN;NGA;ZAF").
year: Snapshot comparison year. If omitted, selected automatically.
include_time_series: Whether to return time-series data for trend comparison.
start_year: Start year for time-series alignment. Defaults to last 5 years if omitted.
end_year: End year for time-series alignment. Defaults to current year if omitted.
disaggregation_filters: Optional dimension filters.
"""
norm_filters = _normalize_disaggregation_filters(disaggregation_filters)
return await data360_api.compare_countries(
database_id=database_id,
indicator_id=indicator_id,
country_codes=country_codes,
year=year,
include_time_series=include_time_series,
start_year=start_year,
end_year=end_year,
disaggregation_filters=norm_filters,
)
# ---------------------------------------------------------------------------
# Tool Registration
# ---------------------------------------------------------------------------
search_indicators = mcp.tool(
instrument_mcp_tool(_search_indicators, tool_name="data360_search_indicators"),
name="data360_search_indicators",
)
search_datasets = mcp.tool(
instrument_mcp_tool(_search_datasets, tool_name="data360_search_datasets"),
name="data360_search_datasets",
)
get_metadata = mcp.tool(
instrument_mcp_tool(_get_metadata, tool_name="data360_get_metadata"),
name="data360_get_metadata",
)
get_data = mcp.tool(
instrument_mcp_tool(_get_data, tool_name="data360_get_data"),
name="data360_get_data",
)
get_disaggregation = mcp.tool(
instrument_mcp_tool(_get_disaggregation, tool_name="data360_get_disaggregation"),
name="data360_get_disaggregation",
)
find_codelist_value = mcp.tool(
instrument_mcp_tool(_find_codelist_value, tool_name="data360_find_codelist_value"),
name="data360_find_codelist_value",
)
list_indicators = mcp.tool(
instrument_mcp_tool(_list_indicators, tool_name="data360_list_indicators"),
name="data360_list_indicators",
)
get_data_api_url = mcp.tool(
instrument_mcp_tool(_get_data_api_url, tool_name="data360_get_data_api_url"),
name="data360_get_data_api_url",
)
get_viz_spec = mcp.tool(
instrument_mcp_tool(_get_viz_spec, tool_name="data360_get_viz_spec"),
name="data360_get_viz_spec",
app=AppConfig(resource_uri="ui://data360-chart/index.html"),
)
get_multi_indicator_viz_spec = mcp.tool(
instrument_mcp_tool(
_get_multi_indicator_viz_spec,
tool_name="data360_get_multi_indicator_viz_spec",
),
name="data360_get_multi_indicator_viz_spec",
app=AppConfig(resource_uri="ui://data360-chart/index.html"),
)
get_supported_chart_types = mcp.tool(
instrument_mcp_tool(
_get_supported_chart_types,
tool_name="data360_get_supported_chart_types",
),
name="data360_get_supported_chart_types",
)
expand_country_group = mcp.tool(
instrument_mcp_tool(
_expand_country_group, tool_name="data360_expand_country_group"
),
name="data360_expand_country_group",
)
# ---------------------------------------------------------------------------
# Data Aggregation Tools (with custom serialization)
# ---------------------------------------------------------------------------
summarize_data = mcp.add_tool(
Tool.from_function(
instrument_mcp_tool(_summarize_data, tool_name="data360_summarize_data"),
name="data360_summarize_data",
serializer=_compact_aggregation_serializer,
)
)
rank_countries = mcp.add_tool(
Tool.from_function(
instrument_mcp_tool(_rank_countries, tool_name="data360_rank_countries"),
name="data360_rank_countries",
serializer=_compact_aggregation_serializer,
)
)
compare_countries = mcp.add_tool(
Tool.from_function(
instrument_mcp_tool(_compare_countries, tool_name="data360_compare_countries"),
name="data360_compare_countries",
serializer=_compact_aggregation_serializer,
)
)
@mcp.resource("ui://data360-chart/index.html")
def data360_chart_html() -> str:
"""HTML resource for the Data360 self-contained Vega-Lite chart viewer Custom HTML app."""
vega_js, vega_lite_js, vega_embed_js, vega_interpreter_js = get_cached_vega_libs()
html_template = """<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Data360 Vega-Lite Renderer</title>
<style>
body {
margin: 0;
padding: 8px;
background: transparent;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
}
#vis {
width: 100%;
height: 100%;
min-height: 400px;
}
</style>
<script>{vega_js}</script>
<script>{vega_interpreter_js}</script>
<script>{vega_lite_js}</script>
<script>{vega_embed_js}</script>
</head>
<body>
<div id="vis"></div>
<script type="module">
class McpAppClient {
constructor() {
this.pendingRequests = new Map();
this.requestId = 0;
this.initialized = false;
this.hostContext = null;
window.addEventListener('message', (e) => this.handleMessage(e));
this.initialize();
}
async initialize() {
try {
const result = await this.request('ui/initialize', {
appInfo: { name: 'Data360 Chart', version: '1.0.0' },
appCapabilities: {},
protocolVersion: '2025-11-21'
});
this.hostContext = result.hostContext;
this.initialized = true;
this.notify('ui/notifications/initialized', {});
this.reportSize();
} catch (error) {
console.error('Failed to initialize MCP App:', error);
}
}
handleMessage(event) {
const data = event.data;
if (!data || typeof data !== 'object') return;
if ('id' in data && this.pendingRequests.has(data.id)) {
const { resolve, reject } = this.pendingRequests.get(data.id);
this.pendingRequests.delete(data.id);
if (data.error) {
reject(new Error(data.error.message));
} else {
resolve(data.result);
}
return;
}
if (data.method === 'ui/notifications/tool-result') {
try {
const result = data.params;
let spec = null;
let strategy = null;
if (result.structuredContent) {
spec = result.structuredContent.spec;
strategy = result.structuredContent.strategy;
}
if (!spec && result.content) {
const textBlock = result.content.find(c => c.type === 'text');
if (textBlock) {
try {
const payload = JSON.parse(textBlock.text);
spec = payload.spec;
strategy = payload.strategy;
} catch (e) {
// Ignore JSON parse error for plain text
}
}
}
renderChart(spec, strategy);
} catch (e) {
console.error('Error parsing tool result:', e);
}
}
}
request(method, params) {
return new Promise((resolve, reject) => {
const id = ++this.requestId;
this.pendingRequests.set(id, { resolve, reject });
window.parent.postMessage({ jsonrpc: '2.0', id, method, params }, '*');
setTimeout(() => {
if (this.pendingRequests.has(id)) {
this.pendingRequests.delete(id);
reject(new Error('Request timed out'));
}
}, 30000);
});
}
notify(method, params) {
window.parent.postMessage({ jsonrpc: '2.0', method, params }, '*');
}
reportSize() {
this.notify('ui/notifications/size-changed', {
height: document.body.scrollHeight
});
}
}
const mcpApp = new McpAppClient();
const visDiv = document.getElementById('vis');
function renderChart(spec, strategy) {
if (!spec) {
visDiv.innerHTML = '<p>No visualization spec available</p>';
mcpApp.reportSize();
return;
}
try {
vegaEmbed("#vis", spec, {
actions: false,
theme: mcpApp.hostContext?.theme === 'dark' ? 'dark' : 'default',
ast: true,
expr: vega.expressionInterpreter
}).then(() => {
mcpApp.reportSize();
}).catch(err => {
console.error(err);
visDiv.innerHTML = `<p style="color:red;">Failed to render chart spec: ${err.message}</p>`;
mcpApp.reportSize();
});
} catch (e) {
visDiv.innerHTML = `<p style="color:red;">Error preparing spec: ${e.message}</p>`;
mcpApp.reportSize();
}
}
window.addEventListener('load', () => {
mcpApp.reportSize();
});
</script>
</body>
</html>
"""
return html_template.replace("{vega_js}", vega_js).replace("{vega_lite_js}", vega_lite_js).replace("{vega_embed_js}", vega_embed_js).replace("{vega_interpreter_js}", vega_interpreter_js)
async def _search_indicators_for_ui(
query: str,
database: Optional[str] = None,
limit: int = 20,
) -> list[dict]:
"""Private helper: returns a flat indicator list for the UI HTML app.
Not registered as an MCP tool — called internally by data360_indicator_explorer
and by the /api/indicators/search FastAPI endpoint.
"""
if not query.strip():
return []
res = await _search_indicators(query=query, database=database, limit=limit)
indicators_data = []
if hasattr(res, "indicators") and res.indicators:
for ind in res.indicators:
indicators_data.append({
"idno": ind.idno,
"database_id": ind.database_id,
"database_name": ind.database_name,
"name": ind.name,
"truncated_definition": ind.truncated_definition,
"time_period_range": ind.time_period_range,
})
return indicators_data
@mcp.resource("ui://data360-choice/index.html")
def data360_choice_html() -> str:
"""HTML resource for the Data360 self-contained choice Custom HTML app."""
return """<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Data360 Option Selector</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Noto+Sans:ital,wght@0,100..900;1,100..900&display=swap" rel="stylesheet">
<style>
:root, .light {
--bg-color: transparent;
--text-color: #0f172a;
--card-bg: #f1f5f9;
--card-border: transparent;
--btn-hover: #e2e8f0;
--btn-border: #cbd5e1;
--muted-color: #64748b;
}
.dark {
--bg-color: transparent;
--text-color: #cbd5e1;
--card-bg: #1e293b;
--card-border: transparent;
--btn-hover: #334155;
--btn-border: #475569;
--muted-color: #94a3b8;
}
@media (prefers-color-scheme: dark) {
:root:not(.light) {
--bg-color: transparent;
--text-color: #cbd5e1;
--card-bg: #1e293b;
--card-border: transparent;
--btn-hover: #334155;
--btn-border: #475569;
--muted-color: #94a3b8;
}
}
body {
margin: 0;
padding: 8px 12px;
background: var(--bg-color);
color: var(--text-color);
font-family: "Noto Sans", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
box-sizing: border-box;
}
.prompt-title {
font-size: 1.15rem;
font-weight: 500;
color: var(--text-color);
margin: 0 0 16px 0;
line-height: 1.4;
}
.choices-container {
display: flex;
gap: 12px;
flex-wrap: wrap;
width: 100%;
}
.choice-card {
display: flex;
flex-direction: column;
justify-content: space-between;
align-items: flex-start;
flex: 1 1 calc(33.333% - 8px);
min-width: 180px;
padding: 16px 20px;
background: var(--card-bg);
border: 1px solid var(--card-border);
border-radius: 1.25rem;
color: var(--text-color);
font-size: 0.95rem;
font-weight: 500;
font-family: inherit;
cursor: pointer;
text-align: left;
outline: none;
box-sizing: border-box;
transition: background-color 0.15s, border-color 0.15s, transform 0.1s;
}
.choice-card:hover:not(:disabled) {
background: var(--btn-hover);
border-color: var(--btn-border);
transform: translateY(-1px);
}
.choice-card:active:not(:disabled) {
transform: translateY(0);
}
.choice-card:disabled {
cursor: not-allowed;
}
.choice-card:disabled:not(.selected) {
opacity: 0.4;
}
.choice-card.selected {
background: var(--btn-hover) !important;
border-color: var(--btn-border) !important;
opacity: 1 !important;
transform: none !important;
}
.choice-text {
flex-grow: 1;
margin-bottom: 16px;
line-height: 1.35;
}
.routing-icon {
font-size: 1.25rem;
font-weight: bold;
color: var(--text-color);
opacity: 0.8;
}
.response-sent {
font-size: 0.9rem;
color: var(--muted-color);
margin-top: 12px;
display: none;
}
.choice-card.specify-mode {
cursor: default;
transform: none !important;
background: var(--btn-hover);
border-color: var(--btn-border);
width: 100%;
flex: 1 1 100%;
align-items: stretch;
}
.specify-input {
flex-grow: 1;
background: transparent;
border: none;
outline: none;
color: var(--text-color);
font-size: 0.95rem;
font-family: inherit;
font-weight: 500;
padding: 4px 0;
width: 100%;
}
.specify-input::placeholder {
color: var(--muted-color);
opacity: 0.6;
}
.specify-submit-btn {
background: transparent;
border: none;
cursor: pointer;
font-size: 1.25rem;
font-weight: bold;
color: var(--text-color);
padding: 0 4px;
display: flex;
align-items: center;
outline: none;
transition: transform 0.1s;
}
.specify-submit-btn:hover {
transform: scale(1.1);
}
.specify-submit-btn:active {
transform: scale(1.0);
}
</style>
</head>
<body>
<p class="prompt-title" id="card-prompt">Loading...</p>
<div class="choices-container" id="choices-container"></div>
<div class="response-sent" id="sent-msg">Response sent.</div>
<script type="module">
class McpAppClient {
constructor() {
this.pendingRequests = new Map();
this.requestId = 0;
this.initialized = false;
this.hostContext = null;
window.addEventListener('message', (e) => this.handleMessage(e));
this.initialize();
}
async initialize() {
try {
const result = await this.request('ui/initialize', {
appInfo: { name: 'Data360 Choice', version: '1.0.0' },
appCapabilities: {},
protocolVersion: '2025-11-21'
});
this.hostContext = result.hostContext;
this.initialized = true;
this.notify('ui/notifications/initialized', {});
this.applyTheme();
this.reportSize();
} catch (error) {
console.error('Failed to initialize MCP App:', error);
}
}
applyTheme() {
const theme = this.hostContext?.theme || (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light');
if (theme === 'dark') {
document.documentElement.classList.add('dark');
document.documentElement.classList.remove('light');
} else {
document.documentElement.classList.add('light');
document.documentElement.classList.remove('dark');
}
}
handleMessage(event) {
const data = event.data;
if (!data || typeof data !== 'object') return;
if ('id' in data && this.pendingRequests.has(data.id)) {
const { resolve, reject } = this.pendingRequests.get(data.id);
this.pendingRequests.delete(data.id);
if (data.error) {
reject(new Error(data.error.message));
} else {
resolve(data.result);
}
return;
}
if (data.method === 'ui/notifications/host-context-changed') {
this.hostContext = { ...this.hostContext, ...data.params };
this.applyTheme();
return;
}
if (data.method === 'ui/notifications/tool-result') {
try {
const result = data.params;
let payload = null;
if (result.content) {
const textBlock = result.content.find(c => c.type === 'text');
if (textBlock) {
payload = JSON.parse(textBlock.text);
}
}
if (payload) {
renderChoiceCard(payload);
}
} catch (e) {
console.error('Error parsing tool result:', e);
}
}
}
request(method, params) {
return new Promise((resolve, reject) => {
const id = ++this.requestId;
this.pendingRequests.set(id, { resolve, reject });
window.parent.postMessage({ jsonrpc: '2.0', id, method, params }, '*');
setTimeout(() => {
if (this.pendingRequests.has(id)) {
this.pendingRequests.delete(id);
reject(new Error('Request timed out'));
}
}, 30000);
});
}
notify(method, params) {
window.parent.postMessage({ jsonrpc: '2.0', method, params }, '*');
}
reportSize() {
this.notify('ui/notifications/size-changed', {
height: document.body.scrollHeight
});
}
async sendMessageToChat(text) {
return this.request('ui/message', {
role: 'user',
content: [{ type: 'text', text }]
});
}
}
const mcpApp = new McpAppClient();
const promptEl = document.getElementById('card-prompt');
const containerEl = document.getElementById('choices-container');
const sentMsgEl = document.getElementById('sent-msg');
function renderChoiceCard(payload) {
const prompt = payload.prompt || "";
const options = payload.options || [];
promptEl.textContent = prompt;
containerEl.innerHTML = "";
options.forEach(opt => {
const btn = document.createElement('button');
btn.className = 'choice-card';
const txtDiv = document.createElement('div');
txtDiv.className = 'choice-text';
txtDiv.textContent = opt;
const iconDiv = document.createElement('div');
iconDiv.className = 'routing-icon';
iconDiv.textContent = '↪';
btn.appendChild(txtDiv);
btn.appendChild(iconDiv);
btn.addEventListener('click', async (e) => {
const lowerOpt = opt.toLowerCase();
if (lowerOpt.includes('specify') || lowerOpt.includes('other') || lowerOpt.includes('custom') || lowerOpt.includes('enter') || opt.endsWith('...')) {
if (btn.classList.contains('specify-mode')) {
return;
}
// Enter specify mode
btn.classList.add('specify-mode');
btn.innerHTML = '';
// Disable other buttons
const cards = containerEl.querySelectorAll('.choice-card');
cards.forEach(c => {
if (c !== btn) {
c.style.opacity = '0.3';
c.disabled = true;
}
});
const form = document.createElement('form');
form.style.display = 'flex';
form.style.width = '100%';
form.style.gap = '8px';
form.style.alignItems = 'center';
form.style.boxSizing = 'border-box';
const input = document.createElement('input');
input.type = 'text';
input.className = 'specify-input';
let placeholder = 'Type here...';
if (opt.toLowerCase().includes('country')) {
placeholder = 'Enter country name...';
} else if (opt.toLowerCase().includes('year') || opt.toLowerCase().includes('range') || opt.toLowerCase().includes('timeframe')) {
placeholder = 'e.g. 2015-2020';
}
input.placeholder = placeholder;
input.required = true;
// Focus input
setTimeout(() => input.focus(), 10);
// Handle Escape key to cancel/revert specify mode
input.addEventListener('keydown', (ev) => {
if (ev.key === 'Escape') {
ev.preventDefault();
ev.stopPropagation();
renderChoiceCard(payload);
}
});
const submitBtn = document.createElement('button');
submitBtn.type = 'submit';
submitBtn.className = 'specify-submit-btn';
submitBtn.textContent = '↪';
form.appendChild(input);
form.appendChild(submitBtn);
btn.appendChild(form);
mcpApp.reportSize();
form.addEventListener('click', (ev) => ev.stopPropagation());
form.addEventListener('submit', async (ev) => {
ev.preventDefault();
const val = input.value.trim();
if (!val) return;
btn.classList.remove('specify-mode');
btn.classList.add('selected');
btn.innerHTML = '';
const finalTxt = document.createElement('div');
finalTxt.className = 'choice-text';
finalTxt.textContent = val;
const finalIcon = document.createElement('div');
finalIcon.className = 'routing-icon';
finalIcon.textContent = '↪';
btn.appendChild(finalTxt);
btn.appendChild(finalIcon);
try {
await mcpApp.sendMessageToChat(`\u21AA\uFE0E *${val}*`);
} catch (err) {
console.error(err);
btn.classList.remove('selected');
// Restore original list on error
renderChoiceCard(payload);
}
});
return;
}
const cards = containerEl.querySelectorAll('.choice-card');
cards.forEach(c => c.disabled = true);
btn.classList.add('selected');
mcpApp.reportSize();
try {
await mcpApp.sendMessageToChat(`\u21AA\uFE0E *${opt}*`);
} catch (err) {
console.error(err);
btn.classList.remove('selected');
cards.forEach(c => c.disabled = false);
mcpApp.reportSize();
}
});
containerEl.appendChild(btn);
});
mcpApp.reportSize();
setTimeout(() => mcpApp.reportSize(), 50);
}
window.addEventListener('load', () => {
mcpApp.reportSize();
});
</script>
</body>
</html>
"""
@mcp.tool(
name="data360_interactive_choices",
app=AppConfig(resource_uri="ui://data360-choice/index.html", prefers_border=False),
)
async def data360_interactive_choices(
prompt: str,
options: list[str],
title: Optional[str] = None,
) -> ToolResult:
"""Present the user with a set of options to choose from using a custom HTML renderer.
Always call this tool to provide follow-ups and elicitations based on the natural flow of the
conversation and the type of information being discussed. Your goal is to anticipate the
user's next question or provide an easy way to steer a broad topic.
Call this tool in the following scenarios:
1. Single Follow-up (1 choice):
- The "Obvious Next Step": When there is one highly logical action to take after your response.
For example, if you explain a mathematical concept, offer a follow-up to walk through a practical example.
- Deep Dives into Jargon: If your response introduces a complex technical term or a new concept,
offer a single follow-up to explain that specific term so the main response does not get too cluttered.
- Launching Interactive Tools: If you mention that you can build a widget or run a simulation,
provide a single button to let the user trigger that specific interactive element directly.
2. Multiple Choices (2+ choices):
- Broad Overviews & Branching Paths: When you give a high-level summary of a massive topic,
use this to let the user choose exactly which sub-category or "branch" you want to zoom in on next.
- Disambiguation (Clarifying Intent): If the user's request is open-ended or could be interpreted in
a few different ways, present options so the user can clarify exactly which direction they meant to take.
Examples:
* GDP/Metric variant: "Real GDP per capita (constant 2015 US$)" vs "Nominal GDP per capita (current US$)"
* Timeframe/Year range: "Latest available year" vs "Historical trend (last 10 years)" vs "Specify a custom range"
* Breakdown/Disaggregation: "Total economy average" vs "Break down by gender (Male vs Female)" vs "Break down by geographic area (Urban vs Rural)"
- Menus and Brainstorming: When generating lists of ideas (like different programming frameworks,
design patterns, or troubleshooting steps), use this to act like a clickable menu, letting the user
instantly select the one you want to explore.
3. Non-exhaustive Lists (CRITICAL):
- If you present a list of choices that is not exhaustive (such as listing a few popular countries,
specific years, indicator variants, or breakdowns), you MUST always dynamically include a customizable
option as the last item in the options list.
Examples:
* Country list: options=["Kenya", "Nigeria", "South Africa", "United States", "India", "Specify another country..."]
* Year list: options=["2024 (latest)", "Last 5 years", "Last 10 years", "Specify a custom range"]
* Breakdowns: options=["Total Average", "Breakdown by Gender", "Other (specify)"]
Essentially, surface these components whenever you can save the user the effort of typing out the
logical next prompt, or when the conversation has reached a crossroads and you need the user to choose
the direction.
Args:
prompt: The question or decision to present to the user.
options: List of options the user can choose from.
title: Optional heading for the card.
"""
payload = {
"prompt": prompt,
"options": options,
"title": title or "Choose an Option"
}
return ToolResult(
content=[TextContent(type="text", text=json.dumps(payload))]
)
|