parseapi-mcp 1.12.3 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -40
- package/dist/{chunk-W5DHLSD3.js → chunk-OY4MSQLL.js} +289 -466
- package/dist/http.js +1 -1
- package/dist/registry.js +1 -1
- package/dist/stdio.js +1 -1
- package/package.json +2 -2
|
@@ -46,15 +46,14 @@ import * as z from "zod";
|
|
|
46
46
|
// src/agent-catalog.json
|
|
47
47
|
var agent_catalog_default = {
|
|
48
48
|
schema_version: "1.0.0",
|
|
49
|
-
api_version: "2.
|
|
49
|
+
api_version: "2.1.0",
|
|
50
50
|
operations: {
|
|
51
51
|
email: {
|
|
52
52
|
operation: "email",
|
|
53
53
|
endpoint: "GET /email/{email}",
|
|
54
54
|
determines: [
|
|
55
55
|
"Email syntax and domain mail routing",
|
|
56
|
-
"Consumer, disposable and role-address classifications"
|
|
57
|
-
"With deep=true, a mailbox deliverability observation"
|
|
56
|
+
"Consumer, disposable and role-address classifications"
|
|
58
57
|
],
|
|
59
58
|
does_not_determine: [
|
|
60
59
|
"Recipient identity, consent or ownership",
|
|
@@ -62,29 +61,17 @@ var agent_catalog_default = {
|
|
|
62
61
|
"A new mailbox probe on every request"
|
|
63
62
|
],
|
|
64
63
|
required_context: [
|
|
65
|
-
"email: a complete email address"
|
|
66
|
-
"deep=true only when a mailbox check is needed"
|
|
64
|
+
"email: a complete email address"
|
|
67
65
|
],
|
|
68
66
|
freshness: {
|
|
69
|
-
mode: "
|
|
67
|
+
mode: "dns_ttl",
|
|
70
68
|
mail_routing: {
|
|
71
69
|
mode: "dns_ttl",
|
|
72
70
|
positive_cache_max_seconds: 3600,
|
|
73
71
|
negative_cache_max_seconds: 300,
|
|
74
72
|
shorter_dns_ttl_wins: true,
|
|
75
73
|
stale_if_error: false
|
|
76
|
-
}
|
|
77
|
-
mailbox_corpus_reuse_max_seconds: {
|
|
78
|
-
deliverable: 604800,
|
|
79
|
-
catchall: 2592e3,
|
|
80
|
-
undeliverable: 7776e3
|
|
81
|
-
},
|
|
82
|
-
mailbox_response_cache_ttl_seconds: 86400,
|
|
83
|
-
mailbox_local_cache_ttl_seconds: 3600,
|
|
84
|
-
effective_max_age_seconds: null,
|
|
85
|
-
effective_max_age_status: "not_guaranteed; response-cache refreshes can retain a verdict beyond corpus reuse windows",
|
|
86
|
-
actual_age_seconds: null,
|
|
87
|
-
actual_age_status: "not_exposed"
|
|
74
|
+
}
|
|
88
75
|
},
|
|
89
76
|
uncertainty: {
|
|
90
77
|
valid: {
|
|
@@ -97,34 +84,11 @@ var agent_catalog_default = {
|
|
|
97
84
|
},
|
|
98
85
|
domain_type: {
|
|
99
86
|
null: "No supported reserved namespace classification"
|
|
100
|
-
},
|
|
101
|
-
"deep.deliverable": {
|
|
102
|
-
true: "Mailbox likely exists",
|
|
103
|
-
false: "Negative verification, eligible local disposable/no-route rejection, or invalid syntax that skipped verification; check valid first",
|
|
104
|
-
null: "Mailbox check did not complete; no verification unit is charged"
|
|
105
|
-
},
|
|
106
|
-
"deep.catchall": {
|
|
107
|
-
true: "Domain accepts all addresses; an individual mailbox is not established",
|
|
108
|
-
false: "Not classified as catchall, including invalid input and local rejection where no mailbox probe ran",
|
|
109
|
-
null: "Mailbox check did not complete"
|
|
110
|
-
},
|
|
111
|
-
deep: {
|
|
112
|
-
omitted: "Not requested",
|
|
113
|
-
empty_object: "Requested with an app key; mailbox verification is locked"
|
|
114
87
|
}
|
|
115
88
|
},
|
|
116
89
|
billing: {
|
|
117
90
|
pooled_requests_per_success: 1,
|
|
118
|
-
metered:
|
|
119
|
-
name: "email",
|
|
120
|
-
when: "deep=true and a valid-syntax eligible check completes",
|
|
121
|
-
units_per_completed_check: 1,
|
|
122
|
-
cache_hits_bill_units: true,
|
|
123
|
-
incomplete_check_units: 0,
|
|
124
|
-
eligible_local_negative_check_units: 1,
|
|
125
|
-
invalid_syntax_check_units: 0,
|
|
126
|
-
locked_deep_check_units: 0
|
|
127
|
-
},
|
|
91
|
+
metered: null,
|
|
128
92
|
monetary_quote: null,
|
|
129
93
|
account_state: "unknown; included balance, on-demand access, accepted rates and spend cap require account state"
|
|
130
94
|
},
|
|
@@ -139,18 +103,12 @@ var agent_catalog_default = {
|
|
|
139
103
|
public: "Allowed browser origin required",
|
|
140
104
|
app: "Allowed X-App-Id required"
|
|
141
105
|
},
|
|
142
|
-
deep: {
|
|
143
|
-
secret_or_public: "Uses available included verifications or enabled on-demand allowance, including on Free",
|
|
144
|
-
app: "Locked; returns deep: {} without a verification",
|
|
145
|
-
restricted_demo_key: "Metered deep is denied"
|
|
146
|
-
},
|
|
147
106
|
effective_access: null,
|
|
148
107
|
effective_access_status: "not_checked; key fences, account access, quotas and spending controls still apply"
|
|
149
108
|
},
|
|
150
109
|
retry: {
|
|
151
110
|
client: "javascript_sdk_and_mcp",
|
|
152
111
|
default_retries: 2,
|
|
153
|
-
deep_default_retries: 0,
|
|
154
112
|
retry_http_statuses: [
|
|
155
113
|
429,
|
|
156
114
|
500,
|
|
@@ -160,10 +118,10 @@ var agent_catalog_default = {
|
|
|
160
118
|
],
|
|
161
119
|
retry_network_errors: true,
|
|
162
120
|
successful_unknown_retried: false,
|
|
163
|
-
guidance: "
|
|
121
|
+
guidance: "Basic syntax and routing checks do not establish mailbox deliverability. Use email_verify explicitly for that metered operation."
|
|
164
122
|
},
|
|
165
123
|
docs: {
|
|
166
|
-
help: "https://api.parseapi.com/version/2.
|
|
124
|
+
help: "https://api.parseapi.com/version/2.1.0/email/help",
|
|
167
125
|
guide: "https://parseapi.com/docs/email"
|
|
168
126
|
}
|
|
169
127
|
},
|
|
@@ -198,18 +156,14 @@ var agent_catalog_default = {
|
|
|
198
156
|
false: "Registry reported registered",
|
|
199
157
|
null: "No usable current registry observation, or this name is a subdomain, public suffix or unsupported registration suffix; availability is unknown"
|
|
200
158
|
},
|
|
201
|
-
|
|
202
|
-
omitted: "Not requested",
|
|
203
|
-
empty_object: "Plan does not unlock registration details, or registration is unavailable"
|
|
204
|
-
},
|
|
205
|
-
"deep.registration": {
|
|
159
|
+
registration: {
|
|
206
160
|
omitted: "No entitled, usable registration observation"
|
|
207
161
|
},
|
|
208
|
-
"
|
|
162
|
+
"registration.dnssec": {
|
|
209
163
|
true: "Registry supplied evidence of signed delegation",
|
|
210
164
|
false: "Registry supplied evidence of unsigned delegation",
|
|
211
165
|
null: "Registry did not supply delegation-signing evidence",
|
|
212
|
-
omitted: "No usable registered-domain detail;
|
|
166
|
+
omitted: "No usable registered-domain detail; unregistered availability is reported in Core"
|
|
213
167
|
}
|
|
214
168
|
},
|
|
215
169
|
billing: {
|
|
@@ -232,7 +186,7 @@ var agent_catalog_default = {
|
|
|
232
186
|
},
|
|
233
187
|
deep: {
|
|
234
188
|
entitlement: "Paid plan; app keys retain plan-deep access",
|
|
235
|
-
locked: "Returns
|
|
189
|
+
locked: "Returns absent optional fields"
|
|
236
190
|
},
|
|
237
191
|
effective_access: null,
|
|
238
192
|
effective_access_status: "not_checked; key fences, account access and quotas still apply"
|
|
@@ -252,7 +206,7 @@ var agent_catalog_default = {
|
|
|
252
206
|
guidance: "available=null is a completed HTTP response with an unknown fact, not evidence the domain is free. Do not retry automatically from null; respect rate and quota errors."
|
|
253
207
|
},
|
|
254
208
|
docs: {
|
|
255
|
-
help: "https://api.parseapi.com/version/2.
|
|
209
|
+
help: "https://api.parseapi.com/version/2.1.0/domain/help",
|
|
256
210
|
guide: "https://parseapi.com/docs/domain"
|
|
257
211
|
}
|
|
258
212
|
},
|
|
@@ -295,10 +249,6 @@ var agent_catalog_default = {
|
|
|
295
249
|
http_status: {
|
|
296
250
|
"404": "DNS name does not exist",
|
|
297
251
|
"503": "Temporary DNS failure; no negative verdict"
|
|
298
|
-
},
|
|
299
|
-
deep: {
|
|
300
|
-
omitted: "Not requested",
|
|
301
|
-
empty_object: "Requested; this product has no additional deep fields"
|
|
302
252
|
}
|
|
303
253
|
},
|
|
304
254
|
billing: {
|
|
@@ -322,7 +272,7 @@ var agent_catalog_default = {
|
|
|
322
272
|
},
|
|
323
273
|
deep: {
|
|
324
274
|
entitlement: "All records are core on every plan",
|
|
325
|
-
requested: "Returns
|
|
275
|
+
requested: "Returns absent optional fields"
|
|
326
276
|
},
|
|
327
277
|
effective_access: null,
|
|
328
278
|
effective_access_status: "not_checked; key fences, account access and quotas still apply"
|
|
@@ -342,7 +292,7 @@ var agent_catalog_default = {
|
|
|
342
292
|
guidance: "An empty records array and a DNS-name 404 are negative answers, not transient failures. Reuse records only within their remaining TTL; respect rate and quota errors."
|
|
343
293
|
},
|
|
344
294
|
docs: {
|
|
345
|
-
help: "https://api.parseapi.com/version/2.
|
|
295
|
+
help: "https://api.parseapi.com/version/2.1.0/dns/help",
|
|
346
296
|
guide: "https://parseapi.com/docs/dns"
|
|
347
297
|
}
|
|
348
298
|
},
|
|
@@ -377,9 +327,6 @@ var agent_catalog_default = {
|
|
|
377
327
|
},
|
|
378
328
|
http_status: {
|
|
379
329
|
"503": "Temporary DNS failure; no negative verdict"
|
|
380
|
-
},
|
|
381
|
-
deep: {
|
|
382
|
-
omitted: "This product has no deep response fields"
|
|
383
330
|
}
|
|
384
331
|
},
|
|
385
332
|
billing: {
|
|
@@ -420,7 +367,7 @@ var agent_catalog_default = {
|
|
|
420
367
|
guidance: "Do not retry solely because mx is empty. Use email for mail-route validation or dns for explicit A/AAAA records; respect rate and quota errors."
|
|
421
368
|
},
|
|
422
369
|
docs: {
|
|
423
|
-
help: "https://api.parseapi.com/version/2.
|
|
370
|
+
help: "https://api.parseapi.com/version/2.1.0/mx/help",
|
|
424
371
|
guide: "https://parseapi.com/docs/mx"
|
|
425
372
|
}
|
|
426
373
|
},
|
|
@@ -428,7 +375,7 @@ var agent_catalog_default = {
|
|
|
428
375
|
operation: "country",
|
|
429
376
|
endpoint: "GET /country/{code}",
|
|
430
377
|
determines: [
|
|
431
|
-
"Country everyday identity and references by ISO2, ISO3 or name: names (name, name_full, name_local), demonym, primary country code, iso_alpha3 and iso_numeric, continent, region, subregion, currency, calling code, flag, languages, timezones, borders, bloc codes
|
|
378
|
+
"Country everyday identity and references by ISO2, ISO3 or name: names (name, name_full, name_local), demonym, primary country code, iso_alpha3 and iso_numeric, continent, region, subregion, currency, calling code, flag, languages, timezones, borders, bloc codes, capital with coordinates, and included postal_format and postal_regex form guidance",
|
|
432
379
|
"With entitled deep=true, specialist geography, population, economic and national reference attributes"
|
|
433
380
|
],
|
|
434
381
|
does_not_determine: [
|
|
@@ -447,25 +394,27 @@ var agent_catalog_default = {
|
|
|
447
394
|
actual_age_status: "not_exposed; population observation evidence remains internal"
|
|
448
395
|
},
|
|
449
396
|
uncertainty: {
|
|
397
|
+
postal_format: {
|
|
398
|
+
null: "Postal-style guidance unavailable; one example may not cover every valid format"
|
|
399
|
+
},
|
|
400
|
+
postal_regex: {
|
|
401
|
+
null: "Postal syntax pattern unavailable; a match does not establish existence or deliverability"
|
|
402
|
+
},
|
|
450
403
|
name_local: {
|
|
451
404
|
null: "Native name unavailable or identical to the original name before display translation"
|
|
452
405
|
},
|
|
453
|
-
|
|
406
|
+
water_area: {
|
|
454
407
|
null: "Unknown or inconsistent with the archived total",
|
|
455
408
|
zero: "Reported zero water area"
|
|
456
409
|
},
|
|
457
|
-
|
|
410
|
+
coastline: {
|
|
458
411
|
null: "Unknown",
|
|
459
412
|
zero: "Reported landlocked coastline"
|
|
460
413
|
},
|
|
461
|
-
|
|
462
|
-
omitted: "Not requested",
|
|
463
|
-
empty_object: "Requested but the plan does not unlock the profile"
|
|
464
|
-
},
|
|
465
|
-
"deep.tax.name": {
|
|
414
|
+
"tax.name": {
|
|
466
415
|
null: "No national consumption levy is named; local levies may still apply"
|
|
467
416
|
},
|
|
468
|
-
"
|
|
417
|
+
"tax.rate": {
|
|
469
418
|
null: "Unavailable or no national levy applies",
|
|
470
419
|
zero: "Known zero national reference rate"
|
|
471
420
|
},
|
|
@@ -501,7 +450,7 @@ var agent_catalog_default = {
|
|
|
501
450
|
},
|
|
502
451
|
deep: {
|
|
503
452
|
entitlement: "Paid plan; app keys retain plan-deep access",
|
|
504
|
-
locked: "Returns
|
|
453
|
+
locked: "Returns absent optional fields"
|
|
505
454
|
},
|
|
506
455
|
effective_access: null,
|
|
507
456
|
effective_access_status: "not_checked; key fences, account access and quotas still apply"
|
|
@@ -521,7 +470,7 @@ var agent_catalog_default = {
|
|
|
521
470
|
guidance: "Do not retry to fill null reference fields or a locked deep object. Preserve unknowns and distinguish reported zero from null; respect rate and quota errors."
|
|
522
471
|
},
|
|
523
472
|
docs: {
|
|
524
|
-
help: "https://api.parseapi.com/version/2.
|
|
473
|
+
help: "https://api.parseapi.com/version/2.1.0/country/help",
|
|
525
474
|
guide: "https://parseapi.com/docs/country"
|
|
526
475
|
}
|
|
527
476
|
},
|
|
@@ -567,16 +516,12 @@ var agent_catalog_default = {
|
|
|
567
516
|
false: "The active timezone rule does not carry its DST indicator",
|
|
568
517
|
null: "Source timezone is unresolved"
|
|
569
518
|
},
|
|
570
|
-
|
|
519
|
+
name: {
|
|
571
520
|
null: "Friendly display name unavailable or inconsistent with the pinned rule"
|
|
572
521
|
},
|
|
573
|
-
|
|
522
|
+
next_dst: {
|
|
574
523
|
null: "No UTC offset change found within 400 days, or source timezone unresolved; not a promise of no future changes"
|
|
575
524
|
},
|
|
576
|
-
deep: {
|
|
577
|
-
omitted: "Not requested",
|
|
578
|
-
object: "Requested; optional detail is included on paid plans or with retained Deep access. Locked requests return {}"
|
|
579
|
-
},
|
|
580
525
|
http_status: {
|
|
581
526
|
"400": "Invalid input, or a repeated/nonexistent source wall time with disambiguation=reject. Supply an explicit UTC offset or choose earlier/later",
|
|
582
527
|
"404": "Unknown IANA timezone",
|
|
@@ -587,7 +532,7 @@ var agent_catalog_default = {
|
|
|
587
532
|
null: "Source is unresolved or ambiguous; no target instant was guessed",
|
|
588
533
|
array: "Ordered requested target objects, including duplicates; all share the same captured instant"
|
|
589
534
|
},
|
|
590
|
-
|
|
535
|
+
resolution: {
|
|
591
536
|
null: "Now, explicit-offset input, no conversion, or unresolved source; no wall-time ambiguity was evaluated",
|
|
592
537
|
object: "Actual unique/overlap/gap classification, applied policy, signed wall adjustment in seconds, and two chronological alternatives for overlap/gap (empty for unique)"
|
|
593
538
|
},
|
|
@@ -602,7 +547,7 @@ var agent_catalog_default = {
|
|
|
602
547
|
ambiguous: "Multiple or truncated candidates; choose/refine explicitly",
|
|
603
548
|
not_found: "No usable match in the available data; not proof the place does not exist"
|
|
604
549
|
},
|
|
605
|
-
|
|
550
|
+
season: {
|
|
606
551
|
null: "No current interval or next DST-flag interval starting within 400 days, or source unresolved",
|
|
607
552
|
object: "Current continuous DST-flag interval, otherwise the next beginning within 400 days; nullable start/end boundaries preserve limits",
|
|
608
553
|
endpoint_null: "Boundary absent from pinned rules or outside supported UTC years 0001 through 9999"
|
|
@@ -650,7 +595,7 @@ var agent_catalog_default = {
|
|
|
650
595
|
guidance: "Do not retry unresolved/ambiguous locations or rejected wall times automatically. Correct the input or choose a resolution. Retried calls with omitted at evaluate a later now; pin an explicit instant when repeatability matters."
|
|
651
596
|
},
|
|
652
597
|
docs: {
|
|
653
|
-
help: "https://api.parseapi.com/version/2.
|
|
598
|
+
help: "https://api.parseapi.com/version/2.1.0/time/help",
|
|
654
599
|
guide: "https://parseapi.com/docs/time"
|
|
655
600
|
}
|
|
656
601
|
},
|
|
@@ -685,7 +630,7 @@ var agent_catalog_default = {
|
|
|
685
630
|
deep: {
|
|
686
631
|
type: "boolean",
|
|
687
632
|
default: false,
|
|
688
|
-
description: "Optional recorded issuer details;
|
|
633
|
+
description: "Optional recorded issuer details on paid plans; existing accounts retain their current Deep access. Six or more digits enable matching."
|
|
689
634
|
}
|
|
690
635
|
}
|
|
691
636
|
},
|
|
@@ -699,27 +644,27 @@ var agent_catalog_default = {
|
|
|
699
644
|
},
|
|
700
645
|
uncertainty: {
|
|
701
646
|
bin: {
|
|
702
|
-
value: "Normalized input string; compare
|
|
647
|
+
value: "Normalized input string; compare prefix to this value when Deep is requested",
|
|
703
648
|
invalid: "HTTP 400; malformed input is not an unknown-prefix result"
|
|
704
649
|
},
|
|
705
650
|
brand: {
|
|
706
651
|
value: "Network key determined independently of issuer records; brand_name is its display name",
|
|
707
652
|
null: "Unknown or ambiguous among reviewed network rules; send more prefix digits when available, up to 11"
|
|
708
653
|
},
|
|
709
|
-
|
|
654
|
+
prefix: {
|
|
710
655
|
null: "HTTP 200: fewer than six digits or no recorded directory match; not a verdict about a card or account",
|
|
711
656
|
equals_bin: "An exact recorded-prefix match for the supplied digits; individual fields can still be null",
|
|
712
657
|
shorter_than_bin: "A broader reference match only; an eight-digit input matching six digits does not establish an exact eight-digit allocation"
|
|
713
658
|
},
|
|
714
|
-
|
|
659
|
+
metadata: {
|
|
715
660
|
null: "Unknown in the one matched record. A more specific record masks its parent, including null fields; never backfill from a shorter prefix"
|
|
716
661
|
},
|
|
717
|
-
|
|
662
|
+
prepaid: {
|
|
718
663
|
true: "Explicitly recorded as prepaid",
|
|
719
664
|
false: "Explicitly recorded as not prepaid",
|
|
720
665
|
null: "Unknown, not false"
|
|
721
666
|
},
|
|
722
|
-
|
|
667
|
+
type: {
|
|
723
668
|
null: "Unknown or mixed funding type"
|
|
724
669
|
},
|
|
725
670
|
logo: {
|
|
@@ -731,7 +676,7 @@ var agent_catalog_default = {
|
|
|
731
676
|
metered: null,
|
|
732
677
|
monetary_quote: null,
|
|
733
678
|
account_state: "unknown; pooled allowance and accepted account terms are not checked",
|
|
734
|
-
deep: "Included in the same pooled request on
|
|
679
|
+
deep: "Included in the same pooled request on paid plans. Existing accounts retain their current Deep access"
|
|
735
680
|
},
|
|
736
681
|
access: {
|
|
737
682
|
api_key_required: true,
|
|
@@ -762,7 +707,7 @@ var agent_catalog_default = {
|
|
|
762
707
|
guidance: "Do not retry a successful unknown prefix or null fields to manufacture a match. Honor Retry-After; waits over five seconds return the API error without automatic retry."
|
|
763
708
|
},
|
|
764
709
|
docs: {
|
|
765
|
-
help: "https://api.parseapi.com/version/2.
|
|
710
|
+
help: "https://api.parseapi.com/version/2.1.0/card/help",
|
|
766
711
|
guide: "https://parseapi.com/docs/card",
|
|
767
712
|
attribution: "https://parseapi.com/legal/attribution#bin"
|
|
768
713
|
}
|
|
@@ -838,7 +783,7 @@ var agent_catalog_default = {
|
|
|
838
783
|
guidance: "Do not retry an empty match list automatically. Correct or broaden the identifier query."
|
|
839
784
|
},
|
|
840
785
|
docs: {
|
|
841
|
-
help: "https://api.parseapi.com/version/2.
|
|
786
|
+
help: "https://api.parseapi.com/version/2.1.0/time/help",
|
|
842
787
|
guide: "https://parseapi.com/docs/time"
|
|
843
788
|
}
|
|
844
789
|
},
|
|
@@ -861,18 +806,15 @@ var agent_catalog_default = {
|
|
|
861
806
|
],
|
|
862
807
|
freshness: {
|
|
863
808
|
mode: "pinned_reference",
|
|
864
|
-
edition_field: "metadata.edition on catalog
|
|
865
|
-
|
|
866
|
-
|
|
809
|
+
edition_field: "metadata.edition on the catalog download",
|
|
810
|
+
actual_age_status: "Not exposed; a pinned source revision does not establish observation age.",
|
|
811
|
+
completeness_field: "metadata.completeness.complete on the catalog download; null is unknown"
|
|
867
812
|
},
|
|
868
813
|
uncertainty: {
|
|
869
|
-
|
|
870
|
-
omitted: "Not requested."
|
|
871
|
-
},
|
|
872
|
-
"deep.base": {
|
|
814
|
+
base: {
|
|
873
815
|
omitted: "No available loaded parent variant"
|
|
874
816
|
},
|
|
875
|
-
|
|
817
|
+
artwork: {
|
|
876
818
|
omitted_style: "Within an explicitly returned artwork object, the style has no verified asset for this glyph. Compact catalog records deliberately omit artwork."
|
|
877
819
|
},
|
|
878
820
|
shortcode_source: "Named presets have explicit provenance and compatibility caveats; missing or ambiguous aliases are not fabricated"
|
|
@@ -913,7 +855,7 @@ var agent_catalog_default = {
|
|
|
913
855
|
guidance: "Do not retry to fill missing source facts or unsupported glyphs. Ordinary retries can consume additional pooled requests; rate and quota limits still apply."
|
|
914
856
|
},
|
|
915
857
|
docs: {
|
|
916
|
-
help: "https://api.parseapi.com/version/2.
|
|
858
|
+
help: "https://api.parseapi.com/version/2.1.0/emoji/help",
|
|
917
859
|
guide: "https://parseapi.com/docs/emoji"
|
|
918
860
|
}
|
|
919
861
|
},
|
|
@@ -935,18 +877,15 @@ var agent_catalog_default = {
|
|
|
935
877
|
],
|
|
936
878
|
freshness: {
|
|
937
879
|
mode: "pinned_reference",
|
|
938
|
-
edition_field: "metadata.edition on catalog
|
|
939
|
-
|
|
940
|
-
|
|
880
|
+
edition_field: "metadata.edition on the catalog download",
|
|
881
|
+
actual_age_status: "Not exposed; a pinned source revision does not establish observation age.",
|
|
882
|
+
completeness_field: "metadata.completeness.complete on the catalog download; null is unknown"
|
|
941
883
|
},
|
|
942
884
|
uncertainty: {
|
|
943
|
-
|
|
944
|
-
omitted: "Not requested."
|
|
945
|
-
},
|
|
946
|
-
"deep.base": {
|
|
885
|
+
base: {
|
|
947
886
|
omitted: "No available loaded parent variant"
|
|
948
887
|
},
|
|
949
|
-
|
|
888
|
+
artwork: {
|
|
950
889
|
omitted_style: "Within an explicitly returned artwork object, the style has no verified asset for this glyph. Compact catalog records deliberately omit artwork."
|
|
951
890
|
},
|
|
952
891
|
shortcode_source: "Named presets have explicit provenance and compatibility caveats; missing or ambiguous aliases are not fabricated"
|
|
@@ -987,7 +926,7 @@ var agent_catalog_default = {
|
|
|
987
926
|
guidance: "Do not retry to fill missing source facts or unsupported glyphs. Ordinary retries can consume additional pooled requests; rate and quota limits still apply."
|
|
988
927
|
},
|
|
989
928
|
docs: {
|
|
990
|
-
help: "https://api.parseapi.com/version/2.
|
|
929
|
+
help: "https://api.parseapi.com/version/2.1.0/emoji/help",
|
|
991
930
|
guide: "https://parseapi.com/docs/emoji"
|
|
992
931
|
}
|
|
993
932
|
},
|
|
@@ -1008,18 +947,15 @@ var agent_catalog_default = {
|
|
|
1008
947
|
],
|
|
1009
948
|
freshness: {
|
|
1010
949
|
mode: "pinned_reference",
|
|
1011
|
-
edition_field: "metadata.edition on catalog
|
|
1012
|
-
|
|
1013
|
-
|
|
950
|
+
edition_field: "metadata.edition on the catalog download",
|
|
951
|
+
actual_age_status: "Not exposed; a pinned source revision does not establish observation age.",
|
|
952
|
+
completeness_field: "metadata.completeness.complete on the catalog download; null is unknown"
|
|
1014
953
|
},
|
|
1015
954
|
uncertainty: {
|
|
1016
|
-
|
|
1017
|
-
omitted: "Not requested."
|
|
1018
|
-
},
|
|
1019
|
-
"deep.base": {
|
|
955
|
+
base: {
|
|
1020
956
|
omitted: "No available loaded parent variant"
|
|
1021
957
|
},
|
|
1022
|
-
|
|
958
|
+
artwork: {
|
|
1023
959
|
omitted_style: "Within an explicitly returned artwork object, the style has no verified asset for this glyph. Compact catalog records deliberately omit artwork."
|
|
1024
960
|
},
|
|
1025
961
|
shortcode_source: "Named presets have explicit provenance and compatibility caveats; missing or ambiguous aliases are not fabricated"
|
|
@@ -1060,7 +996,7 @@ var agent_catalog_default = {
|
|
|
1060
996
|
guidance: "Do not retry to fill missing source facts or unsupported glyphs. Ordinary retries can consume additional pooled requests; rate and quota limits still apply."
|
|
1061
997
|
},
|
|
1062
998
|
docs: {
|
|
1063
|
-
help: "https://api.parseapi.com/version/2.
|
|
999
|
+
help: "https://api.parseapi.com/version/2.1.0/emoji/help",
|
|
1064
1000
|
guide: "https://parseapi.com/docs/emoji"
|
|
1065
1001
|
}
|
|
1066
1002
|
},
|
|
@@ -1079,9 +1015,9 @@ var agent_catalog_default = {
|
|
|
1079
1015
|
],
|
|
1080
1016
|
freshness: {
|
|
1081
1017
|
mode: "pinned_reference",
|
|
1082
|
-
edition_field: "metadata.edition on catalog
|
|
1083
|
-
|
|
1084
|
-
|
|
1018
|
+
edition_field: "metadata.edition on the catalog download",
|
|
1019
|
+
actual_age_status: "Not exposed; a pinned source revision does not establish observation age.",
|
|
1020
|
+
completeness_field: "metadata.completeness.complete on the catalog download; null is unknown"
|
|
1085
1021
|
},
|
|
1086
1022
|
billing: {
|
|
1087
1023
|
pooled_requests_per_success: 1,
|
|
@@ -1115,64 +1051,7 @@ var agent_catalog_default = {
|
|
|
1115
1051
|
guidance: "Do not retry to fill missing source facts or unsupported glyphs. Ordinary retries can consume additional pooled requests; rate and quota limits still apply."
|
|
1116
1052
|
},
|
|
1117
1053
|
docs: {
|
|
1118
|
-
help: "https://api.parseapi.com/version/2.
|
|
1119
|
-
guide: "https://parseapi.com/docs/emoji"
|
|
1120
|
-
}
|
|
1121
|
-
},
|
|
1122
|
-
emoji_metadata: {
|
|
1123
|
-
operation: "emoji_metadata",
|
|
1124
|
-
endpoint: "GET /emoji/metadata",
|
|
1125
|
-
determines: [
|
|
1126
|
-
"Loaded inventory total, content edition, completeness and required notices",
|
|
1127
|
-
"Loaded artwork coverage, source licenses and notices"
|
|
1128
|
-
],
|
|
1129
|
-
does_not_determine: [
|
|
1130
|
-
"A guarantee that every upstream artwork source supports the newest Unicode release",
|
|
1131
|
-
"Account entitlement or a monetary quote"
|
|
1132
|
-
],
|
|
1133
|
-
required_context: [
|
|
1134
|
-
"No required input",
|
|
1135
|
-
"The API and MCP return the same metadata; data notices are embedded and artwork notice files are linked"
|
|
1136
|
-
],
|
|
1137
|
-
freshness: {
|
|
1138
|
-
mode: "pinned_reference",
|
|
1139
|
-
edition_field: "metadata.edition on catalog/metadata",
|
|
1140
|
-
completeness_field: "metadata.completeness on catalog/metadata",
|
|
1141
|
-
actual_age_status: "Not exposed; a pinned source revision does not establish observation age."
|
|
1142
|
-
},
|
|
1143
|
-
billing: {
|
|
1144
|
-
pooled_requests_per_success: 1,
|
|
1145
|
-
account_state: "unknown; account allowance, credentials, quotas and accepted terms are not evaluated"
|
|
1146
|
-
},
|
|
1147
|
-
access: {
|
|
1148
|
-
api_key_required: true,
|
|
1149
|
-
key_types: [
|
|
1150
|
-
"secret",
|
|
1151
|
-
"public",
|
|
1152
|
-
"app"
|
|
1153
|
-
],
|
|
1154
|
-
key_fences: {
|
|
1155
|
-
public: "Allowed browser origin required",
|
|
1156
|
-
app: "Allowed X-App-Id required"
|
|
1157
|
-
},
|
|
1158
|
-
effective_access_status: "Not checked; credential fences, account access and quotas still apply."
|
|
1159
|
-
},
|
|
1160
|
-
retry: {
|
|
1161
|
-
client: "javascript_sdk_and_mcp",
|
|
1162
|
-
default_retries: 2,
|
|
1163
|
-
retry_http_statuses: [
|
|
1164
|
-
429,
|
|
1165
|
-
500,
|
|
1166
|
-
502,
|
|
1167
|
-
503,
|
|
1168
|
-
504
|
|
1169
|
-
],
|
|
1170
|
-
retry_network_errors: true,
|
|
1171
|
-
successful_unknown_retried: false,
|
|
1172
|
-
guidance: "Do not retry to fill missing source facts or unsupported glyphs. Ordinary retries can consume additional pooled requests; rate and quota limits still apply."
|
|
1173
|
-
},
|
|
1174
|
-
docs: {
|
|
1175
|
-
help: "https://api.parseapi.com/version/2.0.0/emoji/help",
|
|
1054
|
+
help: "https://api.parseapi.com/version/2.1.0/emoji/help",
|
|
1176
1055
|
guide: "https://parseapi.com/docs/emoji"
|
|
1177
1056
|
}
|
|
1178
1057
|
},
|
|
@@ -1180,43 +1059,35 @@ var agent_catalog_default = {
|
|
|
1180
1059
|
operation: "emoji_catalog",
|
|
1181
1060
|
endpoint: "GET /emoji/catalog",
|
|
1182
1061
|
determines: [
|
|
1183
|
-
"
|
|
1184
|
-
"JSON qualification maps, source aliases, legacy winners and native search facts for offline clients"
|
|
1062
|
+
"One compact JSON catalog download URL; the download contains inventory, lookup maps and required notices."
|
|
1185
1063
|
],
|
|
1186
1064
|
does_not_determine: [
|
|
1187
1065
|
"A full catalog embedded in MCP model context",
|
|
1188
1066
|
"A translated label for every row merely from a supported locale"
|
|
1189
1067
|
],
|
|
1190
1068
|
required_context: [
|
|
1191
|
-
"
|
|
1192
|
-
"Optional filters and language; download_url requires an authenticated HTTP request",
|
|
1193
|
-
"Compact is the default; request profile=full for artwork. MCP metadata describes the complete inventory; the downloaded file supplies the selected total and scope."
|
|
1069
|
+
"Optional catalog filters and display language. Download with an API key."
|
|
1194
1070
|
],
|
|
1195
1071
|
freshness: {
|
|
1196
1072
|
mode: "pinned_reference",
|
|
1197
|
-
edition_field: "metadata.edition on catalog
|
|
1198
|
-
|
|
1199
|
-
|
|
1073
|
+
edition_field: "metadata.edition on the catalog download",
|
|
1074
|
+
actual_age_status: "Not exposed; a pinned source revision does not establish observation age.",
|
|
1075
|
+
completeness_field: "metadata.completeness.complete on the catalog download; null is unknown"
|
|
1200
1076
|
},
|
|
1201
1077
|
uncertainty: {
|
|
1202
|
-
|
|
1203
|
-
omitted: "Not requested."
|
|
1204
|
-
},
|
|
1205
|
-
"deep.base": {
|
|
1078
|
+
base: {
|
|
1206
1079
|
omitted: "No available loaded parent variant"
|
|
1207
1080
|
},
|
|
1208
|
-
|
|
1081
|
+
artwork: {
|
|
1209
1082
|
omitted_style: "Within an explicitly returned artwork object, the style has no verified asset for this glyph. Compact catalog records deliberately omit artwork."
|
|
1210
1083
|
},
|
|
1211
1084
|
shortcode_source: "Named presets have explicit provenance and compatibility caveats; missing or ambiguous aliases are not fabricated"
|
|
1212
1085
|
},
|
|
1213
1086
|
billing: {
|
|
1214
|
-
pooled_requests_per_success:
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
mcp_behavior: "One metadata read. Following download_url performs one separate pooled request; local operations use no pooled requests.",
|
|
1219
|
-
offline_operations_extra_units: 0
|
|
1087
|
+
pooled_requests_per_success: 0,
|
|
1088
|
+
metered: null,
|
|
1089
|
+
monetary_quote: null,
|
|
1090
|
+
download: "The separate catalog request uses the ordinary pooled read."
|
|
1220
1091
|
},
|
|
1221
1092
|
access: {
|
|
1222
1093
|
api_key_required: true,
|
|
@@ -1249,7 +1120,7 @@ var agent_catalog_default = {
|
|
|
1249
1120
|
guidance: "Do not retry to fill missing source facts or unsupported glyphs. Ordinary retries can consume additional pooled requests; rate and quota limits still apply."
|
|
1250
1121
|
},
|
|
1251
1122
|
docs: {
|
|
1252
|
-
help: "https://api.parseapi.com/version/2.
|
|
1123
|
+
help: "https://api.parseapi.com/version/2.1.0/emoji/help",
|
|
1253
1124
|
guide: "https://parseapi.com/docs/emoji"
|
|
1254
1125
|
}
|
|
1255
1126
|
},
|
|
@@ -1271,18 +1142,15 @@ var agent_catalog_default = {
|
|
|
1271
1142
|
],
|
|
1272
1143
|
freshness: {
|
|
1273
1144
|
mode: "pinned_reference",
|
|
1274
|
-
edition_field: "metadata.edition on catalog
|
|
1275
|
-
|
|
1276
|
-
|
|
1145
|
+
edition_field: "metadata.edition on the catalog download",
|
|
1146
|
+
actual_age_status: "Not exposed; a pinned source revision does not establish observation age.",
|
|
1147
|
+
completeness_field: "metadata.completeness.complete on the catalog download; null is unknown"
|
|
1277
1148
|
},
|
|
1278
1149
|
uncertainty: {
|
|
1279
|
-
|
|
1280
|
-
omitted: "Not requested."
|
|
1281
|
-
},
|
|
1282
|
-
"deep.base": {
|
|
1150
|
+
base: {
|
|
1283
1151
|
omitted: "No available loaded parent variant"
|
|
1284
1152
|
},
|
|
1285
|
-
|
|
1153
|
+
artwork: {
|
|
1286
1154
|
omitted_style: "Within an explicitly returned artwork object, the style has no verified asset for this glyph. Compact catalog records deliberately omit artwork."
|
|
1287
1155
|
}
|
|
1288
1156
|
},
|
|
@@ -1322,7 +1190,7 @@ var agent_catalog_default = {
|
|
|
1322
1190
|
guidance: "Do not retry to fill missing source facts or unsupported glyphs. Ordinary retries can consume additional pooled requests; rate and quota limits still apply."
|
|
1323
1191
|
},
|
|
1324
1192
|
docs: {
|
|
1325
|
-
help: "https://api.parseapi.com/version/2.
|
|
1193
|
+
help: "https://api.parseapi.com/version/2.1.0/emoji/help",
|
|
1326
1194
|
guide: "https://parseapi.com/docs/emoji"
|
|
1327
1195
|
}
|
|
1328
1196
|
},
|
|
@@ -1344,9 +1212,9 @@ var agent_catalog_default = {
|
|
|
1344
1212
|
],
|
|
1345
1213
|
freshness: {
|
|
1346
1214
|
mode: "pinned_reference",
|
|
1347
|
-
edition_field: "metadata.edition on catalog
|
|
1348
|
-
|
|
1349
|
-
|
|
1215
|
+
edition_field: "metadata.edition on the catalog download",
|
|
1216
|
+
actual_age_status: "Not exposed; a pinned source revision does not establish observation age.",
|
|
1217
|
+
completeness_field: "metadata.completeness.complete on the catalog download; null is unknown"
|
|
1350
1218
|
},
|
|
1351
1219
|
uncertainty: {
|
|
1352
1220
|
shortcode_source: "Named presets have explicit provenance and compatibility caveats; missing or ambiguous aliases are not fabricated",
|
|
@@ -1384,7 +1252,7 @@ var agent_catalog_default = {
|
|
|
1384
1252
|
guidance: "Do not retry to fill missing source facts or unsupported glyphs. Ordinary retries can consume additional pooled requests; rate and quota limits still apply."
|
|
1385
1253
|
},
|
|
1386
1254
|
docs: {
|
|
1387
|
-
help: "https://api.parseapi.com/version/2.
|
|
1255
|
+
help: "https://api.parseapi.com/version/2.1.0/emoji/help",
|
|
1388
1256
|
guide: "https://parseapi.com/docs/emoji"
|
|
1389
1257
|
}
|
|
1390
1258
|
},
|
|
@@ -1405,7 +1273,6 @@ var agent_catalog_default = {
|
|
|
1405
1273
|
mode: "matched_annual_editions",
|
|
1406
1274
|
age_basis: "Calendar editions identify retained dates; completeness, pending dates and verification qualify annual review",
|
|
1407
1275
|
source_observations: "Source-byte checks do not renew annual date review",
|
|
1408
|
-
immutable_selection: "Explicit edition pins select public rows only, one unambiguous edition per reached year",
|
|
1409
1276
|
actual_age_seconds: null
|
|
1410
1277
|
},
|
|
1411
1278
|
uncertainty: {
|
|
@@ -1421,7 +1288,7 @@ var agent_catalog_default = {
|
|
|
1421
1288
|
},
|
|
1422
1289
|
access: {
|
|
1423
1290
|
plans: "all",
|
|
1424
|
-
credentials: "Existing permitted API or app key; API 2.
|
|
1291
|
+
credentials: "Existing permitted API or app key; API 2.1.0",
|
|
1425
1292
|
deep: "Not accepted; complete collection metadata is core",
|
|
1426
1293
|
effective_access: null,
|
|
1427
1294
|
preflight_and_tasks: "Unsupported by the current single-value preflight/task execution contract; use a direct collection lookup."
|
|
@@ -1429,11 +1296,10 @@ var agent_catalog_default = {
|
|
|
1429
1296
|
required_context: [
|
|
1430
1297
|
"country: two-letter country code",
|
|
1431
1298
|
"from and to: real inclusive civil dates, at most 731 dates",
|
|
1432
|
-
"Optional type and region; a region must be represented in every reached annual calendar"
|
|
1433
|
-
"Optional edition: one distinct public-calendar hash per reached year, at most three; no observance selector with pins"
|
|
1299
|
+
"Optional type and region; a region must be represented in every reached annual calendar"
|
|
1434
1300
|
],
|
|
1435
1301
|
docs: {
|
|
1436
|
-
help: "https://api.parseapi.com/version/2.
|
|
1302
|
+
help: "https://api.parseapi.com/version/2.1.0/holiday/help",
|
|
1437
1303
|
reference: "https://parseapi.com/docs/holiday"
|
|
1438
1304
|
},
|
|
1439
1305
|
retry: {
|
|
@@ -1461,16 +1327,6 @@ var agent_catalog_default = {
|
|
|
1461
1327
|
region: {
|
|
1462
1328
|
type: "string"
|
|
1463
1329
|
},
|
|
1464
|
-
edition: {
|
|
1465
|
-
type: "array",
|
|
1466
|
-
minItems: 1,
|
|
1467
|
-
maxItems: 3,
|
|
1468
|
-
uniqueItems: true,
|
|
1469
|
-
items: {
|
|
1470
|
-
type: "string",
|
|
1471
|
-
pattern: "^[a-f0-9]{64}$"
|
|
1472
|
-
}
|
|
1473
|
-
},
|
|
1474
1330
|
to: {
|
|
1475
1331
|
type: "string",
|
|
1476
1332
|
format: "date"
|
|
@@ -1484,54 +1340,6 @@ var agent_catalog_default = {
|
|
|
1484
1340
|
additionalProperties: false
|
|
1485
1341
|
}
|
|
1486
1342
|
},
|
|
1487
|
-
holiday_events: {
|
|
1488
|
-
operation: "holiday_events",
|
|
1489
|
-
endpoint: "GET /holiday/{country}/events",
|
|
1490
|
-
determines: [
|
|
1491
|
-
"One cursor page of retained public-calendar corrections, with before/after records and previous/new editions"
|
|
1492
|
-
],
|
|
1493
|
-
does_not_determine: [
|
|
1494
|
-
"Employer closure, pay or leave entitlement",
|
|
1495
|
-
"Municipal, half-day, bank or sector-specific rules outside each calendar scope",
|
|
1496
|
-
"Official verification of curated observances or calculated forecasts",
|
|
1497
|
-
"The current local date in a country; the caller supplies its civil anchor"
|
|
1498
|
-
],
|
|
1499
|
-
freshness: {
|
|
1500
|
-
mode: "immutable_retained_change_history",
|
|
1501
|
-
age_basis: "Calendar editions identify retained dates; completeness, pending dates and verification qualify annual review",
|
|
1502
|
-
actual_age_seconds: null
|
|
1503
|
-
},
|
|
1504
|
-
uncertainty: {
|
|
1505
|
-
complete: false,
|
|
1506
|
-
history_boundary: "history.retained_since declares the retained boundary; no earlier transitions inferred",
|
|
1507
|
-
empty_page: "No retained matching events; inspect coverage separately",
|
|
1508
|
-
cursor: "Unknown cursors 404; another country/year cursor 400"
|
|
1509
|
-
},
|
|
1510
|
-
billing: {
|
|
1511
|
-
pooled_requests_per_success: 1,
|
|
1512
|
-
metered: null,
|
|
1513
|
-
monetary_quote: null
|
|
1514
|
-
},
|
|
1515
|
-
access: {
|
|
1516
|
-
plans: "all",
|
|
1517
|
-
credentials: "Existing permitted API or app key; API 2.0.0 only",
|
|
1518
|
-
deep: "Not accepted; complete collection metadata is core",
|
|
1519
|
-
effective_access: null,
|
|
1520
|
-
preflight_and_tasks: "Unsupported by the current single-value preflight/task execution contract; use a direct collection lookup."
|
|
1521
|
-
},
|
|
1522
|
-
required_context: [
|
|
1523
|
-
"country: exact calendar country",
|
|
1524
|
-
"Optional year and limit from 1 to 100; after is the last immutable event ID"
|
|
1525
|
-
],
|
|
1526
|
-
docs: {
|
|
1527
|
-
help: "https://api.parseapi.com/version/2.0.0/holiday/help",
|
|
1528
|
-
reference: "https://parseapi.com/docs/holiday"
|
|
1529
|
-
},
|
|
1530
|
-
retry: {
|
|
1531
|
-
successful_unknown_retried: false,
|
|
1532
|
-
guidance: "Validation and unavailable-year errors remain explicit; temporary 503 errors follow returned retry guidance."
|
|
1533
|
-
}
|
|
1534
|
-
},
|
|
1535
1343
|
holiday: {
|
|
1536
1344
|
operation: "holiday",
|
|
1537
1345
|
endpoint: "GET /holiday/{country}",
|
|
@@ -1546,8 +1354,7 @@ var agent_catalog_default = {
|
|
|
1546
1354
|
],
|
|
1547
1355
|
required_context: [
|
|
1548
1356
|
"country: a two-letter country code",
|
|
1549
|
-
"Optional year/month/day select a real civil period; full dates use the date path"
|
|
1550
|
-
"Optional edition pins select an exact retained public-calendar version"
|
|
1357
|
+
"Optional year/month/day select a real civil period; full dates use the date path"
|
|
1551
1358
|
],
|
|
1552
1359
|
freshness: {
|
|
1553
1360
|
mode: "stored_annual_calendars",
|
|
@@ -1571,7 +1378,7 @@ var agent_catalog_default = {
|
|
|
1571
1378
|
effective_access: null
|
|
1572
1379
|
},
|
|
1573
1380
|
docs: {
|
|
1574
|
-
help: "https://api.parseapi.com/version/2.
|
|
1381
|
+
help: "https://api.parseapi.com/version/2.1.0/holiday/help",
|
|
1575
1382
|
reference: "https://parseapi.com/docs/holiday"
|
|
1576
1383
|
},
|
|
1577
1384
|
retry: {
|
|
@@ -1596,7 +1403,6 @@ var agent_catalog_default = {
|
|
|
1596
1403
|
mode: "matched_annual_editions",
|
|
1597
1404
|
age_basis: "Retained annual review/publication dates; null review timestamps remain unknown",
|
|
1598
1405
|
source_observations: "Source-byte checks do not renew annual date review",
|
|
1599
|
-
immutable_selection: "Explicit edition pins select public rows only, one unambiguous edition per reached year",
|
|
1600
1406
|
actual_age_seconds: null
|
|
1601
1407
|
},
|
|
1602
1408
|
uncertainty: {
|
|
@@ -1612,7 +1418,7 @@ var agent_catalog_default = {
|
|
|
1612
1418
|
},
|
|
1613
1419
|
access: {
|
|
1614
1420
|
plans: "all",
|
|
1615
|
-
credentials: "Existing permitted API or app key; API 2.
|
|
1421
|
+
credentials: "Existing permitted API or app key; API 2.1.0",
|
|
1616
1422
|
deep: "Not accepted; complete collection metadata is core",
|
|
1617
1423
|
effective_access: null,
|
|
1618
1424
|
preflight_and_tasks: "Unsupported by the current single-value preflight/task execution contract; use a direct collection lookup."
|
|
@@ -1620,11 +1426,10 @@ var agent_catalog_default = {
|
|
|
1620
1426
|
required_context: [
|
|
1621
1427
|
"country: two-letter country code",
|
|
1622
1428
|
"from and to: real inclusive civil dates, at most 731 dates",
|
|
1623
|
-
"Optional type and region; a region must be represented in every reached annual calendar"
|
|
1624
|
-
"Optional edition: one distinct public-calendar hash per reached year, at most three; no observance selector with pins"
|
|
1429
|
+
"Optional type and region; a region must be represented in every reached annual calendar"
|
|
1625
1430
|
],
|
|
1626
1431
|
docs: {
|
|
1627
|
-
help: "https://api.parseapi.com/version/2.
|
|
1432
|
+
help: "https://api.parseapi.com/version/2.1.0/holiday/help",
|
|
1628
1433
|
reference: "https://parseapi.com/docs/holiday"
|
|
1629
1434
|
},
|
|
1630
1435
|
retry: {
|
|
@@ -1652,16 +1457,6 @@ var agent_catalog_default = {
|
|
|
1652
1457
|
region: {
|
|
1653
1458
|
type: "string"
|
|
1654
1459
|
},
|
|
1655
|
-
edition: {
|
|
1656
|
-
type: "array",
|
|
1657
|
-
minItems: 1,
|
|
1658
|
-
maxItems: 3,
|
|
1659
|
-
uniqueItems: true,
|
|
1660
|
-
items: {
|
|
1661
|
-
type: "string",
|
|
1662
|
-
pattern: "^[a-f0-9]{64}$"
|
|
1663
|
-
}
|
|
1664
|
-
},
|
|
1665
1460
|
to: {
|
|
1666
1461
|
type: "string",
|
|
1667
1462
|
format: "date"
|
|
@@ -1674,54 +1469,6 @@ var agent_catalog_default = {
|
|
|
1674
1469
|
],
|
|
1675
1470
|
additionalProperties: false
|
|
1676
1471
|
}
|
|
1677
|
-
},
|
|
1678
|
-
holiday_events: {
|
|
1679
|
-
operation: "holiday_events",
|
|
1680
|
-
endpoint: "GET /holiday/{country}/events",
|
|
1681
|
-
determines: [
|
|
1682
|
-
"One cursor page of retained public-calendar corrections, with before/after records and previous/new editions"
|
|
1683
|
-
],
|
|
1684
|
-
does_not_determine: [
|
|
1685
|
-
"Employer closure, pay or leave entitlement",
|
|
1686
|
-
"Municipal, half-day, bank or sector-specific rules outside each calendar scope",
|
|
1687
|
-
"Official verification of curated observances or calculated forecasts",
|
|
1688
|
-
"The current local date in a country; the caller supplies its civil anchor"
|
|
1689
|
-
],
|
|
1690
|
-
freshness: {
|
|
1691
|
-
mode: "immutable_retained_change_history",
|
|
1692
|
-
age_basis: "created is first-recorded Unix seconds, not source publication or a renewed review",
|
|
1693
|
-
actual_age_seconds: null
|
|
1694
|
-
},
|
|
1695
|
-
uncertainty: {
|
|
1696
|
-
complete: false,
|
|
1697
|
-
history_boundary: "history.retained_since declares the retained boundary; no earlier transitions inferred",
|
|
1698
|
-
empty_page: "No retained matching events; inspect coverage separately",
|
|
1699
|
-
cursor: "Unknown cursors 404; another country/year cursor 400"
|
|
1700
|
-
},
|
|
1701
|
-
billing: {
|
|
1702
|
-
pooled_requests_per_success: 1,
|
|
1703
|
-
metered: null,
|
|
1704
|
-
monetary_quote: null
|
|
1705
|
-
},
|
|
1706
|
-
access: {
|
|
1707
|
-
plans: "all",
|
|
1708
|
-
credentials: "Existing permitted API or app key; API 2.0.0 only",
|
|
1709
|
-
deep: "Not accepted; complete collection metadata is core",
|
|
1710
|
-
effective_access: null,
|
|
1711
|
-
preflight_and_tasks: "Unsupported by the current single-value preflight/task execution contract; use a direct collection lookup."
|
|
1712
|
-
},
|
|
1713
|
-
required_context: [
|
|
1714
|
-
"country: exact calendar country",
|
|
1715
|
-
"Optional year and limit from 1 to 100; after is the last immutable event ID"
|
|
1716
|
-
],
|
|
1717
|
-
docs: {
|
|
1718
|
-
help: "https://api.parseapi.com/version/2.0.0/holiday/help",
|
|
1719
|
-
reference: "https://parseapi.com/docs/holiday"
|
|
1720
|
-
},
|
|
1721
|
-
retry: {
|
|
1722
|
-
successful_unknown_retried: false,
|
|
1723
|
-
guidance: "Validation and unavailable-year errors remain explicit; temporary 503 errors follow returned retry guidance."
|
|
1724
|
-
}
|
|
1725
1472
|
}
|
|
1726
1473
|
}
|
|
1727
1474
|
},
|
|
@@ -1730,7 +1477,7 @@ var agent_catalog_default = {
|
|
|
1730
1477
|
endpoint: "GET /postal/{code}?country={country}",
|
|
1731
1478
|
determines: [
|
|
1732
1479
|
"Postal code, qualified ZIP type, available place names, coordinates and timezone",
|
|
1733
|
-
"Optional paid Deep adds area, elevation, population, tax references,
|
|
1480
|
+
"Optional paid Deep adds area, elevation, population, currency, grouped tax references, up to eight same-country neighbor codes and metro associations where available"
|
|
1734
1481
|
],
|
|
1735
1482
|
does_not_determine: [
|
|
1736
1483
|
"Street-address deliverability or USPS DPV",
|
|
@@ -1786,7 +1533,7 @@ var agent_catalog_default = {
|
|
|
1786
1533
|
guidance: "A successful response with unknown facts is a completed result, not a reason to retry. Respect explicit unavailable errors and retry guidance."
|
|
1787
1534
|
},
|
|
1788
1535
|
docs: {
|
|
1789
|
-
help: "https://api.parseapi.com/version/2.
|
|
1536
|
+
help: "https://api.parseapi.com/version/2.1.0/postal/help",
|
|
1790
1537
|
guide: "https://parseapi.com/docs/postal"
|
|
1791
1538
|
}
|
|
1792
1539
|
},
|
|
@@ -1849,7 +1596,7 @@ var agent_catalog_default = {
|
|
|
1849
1596
|
guidance: "A successful response with unknown facts is a completed result, not a reason to retry. Respect explicit unavailable errors and retry guidance."
|
|
1850
1597
|
},
|
|
1851
1598
|
docs: {
|
|
1852
|
-
help: "https://api.parseapi.com/version/2.
|
|
1599
|
+
help: "https://api.parseapi.com/version/2.1.0/postal/help",
|
|
1853
1600
|
guide: "https://parseapi.com/docs/postal"
|
|
1854
1601
|
}
|
|
1855
1602
|
},
|
|
@@ -1911,7 +1658,7 @@ var agent_catalog_default = {
|
|
|
1911
1658
|
guidance: "A successful response with unknown facts is a completed result, not a reason to retry. Respect explicit unavailable errors and retry guidance."
|
|
1912
1659
|
},
|
|
1913
1660
|
docs: {
|
|
1914
|
-
help: "https://api.parseapi.com/version/2.
|
|
1661
|
+
help: "https://api.parseapi.com/version/2.1.0/postal/help",
|
|
1915
1662
|
guide: "https://parseapi.com/docs/postal"
|
|
1916
1663
|
}
|
|
1917
1664
|
},
|
|
@@ -1919,11 +1666,11 @@ var agent_catalog_default = {
|
|
|
1919
1666
|
operation: "city",
|
|
1920
1667
|
endpoint: "GET /city/{name}",
|
|
1921
1668
|
endpoints: {
|
|
1922
|
-
resource: "GET /city/id/{id}
|
|
1669
|
+
resource: "GET /city/id/{id}",
|
|
1923
1670
|
typeahead: "GET /city?q={query}",
|
|
1924
|
-
browse: "GET /city?browse=true
|
|
1671
|
+
browse: "GET /city?browse=true",
|
|
1925
1672
|
spelling: "GET /city/search?q={query}&match={exact|prefix|fuzzy}",
|
|
1926
|
-
nearby_coordinates: "GET /city?lat={lat}&lon={lon}&nearby=true
|
|
1673
|
+
nearby_coordinates: "GET /city?lat={lat}&lon={lon}&nearby=true",
|
|
1927
1674
|
children: "GET /city/id/{id}/children",
|
|
1928
1675
|
ancestors: "GET /city/id/{id}/ancestors",
|
|
1929
1676
|
siblings: "GET /city/id/{id}/siblings",
|
|
@@ -1950,8 +1697,8 @@ var agent_catalog_default = {
|
|
|
1950
1697
|
"Keep all filters, limit, language and shape options unchanged when reusing next_cursor"
|
|
1951
1698
|
],
|
|
1952
1699
|
response: {
|
|
1953
|
-
resource: "
|
|
1954
|
-
collection: "
|
|
1700
|
+
resource: "Lookup: complete ordinary City fields, including its id",
|
|
1701
|
+
collection: "Each route retains its default cities or nearby collection and pagination; explicit /city/search and relationships retain canonical data lists",
|
|
1955
1702
|
legacy: "Default lookup, typeahead and named-nearby envelopes remain compatible",
|
|
1956
1703
|
geojson: "format=geojson: Feature or FeatureCollection; null geometry when coordinates are unavailable"
|
|
1957
1704
|
},
|
|
@@ -2021,11 +1768,116 @@ var agent_catalog_default = {
|
|
|
2021
1768
|
]
|
|
2022
1769
|
},
|
|
2023
1770
|
docs: {
|
|
2024
|
-
help: "https://api.parseapi.com/version/2.
|
|
1771
|
+
help: "https://api.parseapi.com/version/2.1.0/city/help",
|
|
2025
1772
|
guide: "https://parseapi.com/docs/city",
|
|
2026
1773
|
selection: "https://parseapi.com/docs/city#choose-a-city",
|
|
2027
1774
|
continuity: "https://parseapi.com/docs/city#stable-ids"
|
|
2028
1775
|
}
|
|
1776
|
+
},
|
|
1777
|
+
email_verify: {
|
|
1778
|
+
operation: "email_verify",
|
|
1779
|
+
endpoint: "POST /email/verify",
|
|
1780
|
+
determines: [
|
|
1781
|
+
"A complete Email result and, when completed, a mailbox deliverability observation."
|
|
1782
|
+
],
|
|
1783
|
+
does_not_determine: [
|
|
1784
|
+
"Recipient identity, consent or ownership",
|
|
1785
|
+
"Guaranteed delivery to an inbox",
|
|
1786
|
+
"A new mailbox probe on every request"
|
|
1787
|
+
],
|
|
1788
|
+
required_context: [
|
|
1789
|
+
"email: a complete email address in the JSON request body."
|
|
1790
|
+
],
|
|
1791
|
+
freshness: {
|
|
1792
|
+
mode: "observation_reuse",
|
|
1793
|
+
mail_routing: {
|
|
1794
|
+
mode: "dns_ttl",
|
|
1795
|
+
positive_cache_max_seconds: 3600,
|
|
1796
|
+
negative_cache_max_seconds: 300,
|
|
1797
|
+
shorter_dns_ttl_wins: true,
|
|
1798
|
+
stale_if_error: false
|
|
1799
|
+
},
|
|
1800
|
+
mailbox_corpus_reuse_max_seconds: {
|
|
1801
|
+
deliverable: 604800,
|
|
1802
|
+
catchall: 2592e3,
|
|
1803
|
+
undeliverable: 7776e3
|
|
1804
|
+
},
|
|
1805
|
+
mailbox_response_cache_ttl_seconds: 86400,
|
|
1806
|
+
mailbox_local_cache_ttl_seconds: 3600,
|
|
1807
|
+
effective_max_age_seconds: null,
|
|
1808
|
+
effective_max_age_status: "not_guaranteed; response-cache refreshes can retain a verdict beyond corpus reuse windows",
|
|
1809
|
+
actual_age_seconds: null,
|
|
1810
|
+
actual_age_status: "not_exposed"
|
|
1811
|
+
},
|
|
1812
|
+
uncertainty: {
|
|
1813
|
+
valid: {
|
|
1814
|
+
true: "Syntax is valid; this does not establish mailbox existence",
|
|
1815
|
+
false: "Syntax is invalid"
|
|
1816
|
+
},
|
|
1817
|
+
domain_valid: {
|
|
1818
|
+
true: "MX or permitted A/AAAA fallback supplies a mail route",
|
|
1819
|
+
false: "When valid=true, no usable mail route, including an explicit null MX. When valid=false, routing was not checked"
|
|
1820
|
+
},
|
|
1821
|
+
domain_type: {
|
|
1822
|
+
null: "No supported reserved namespace classification"
|
|
1823
|
+
},
|
|
1824
|
+
deliverable: {
|
|
1825
|
+
true: "Mailbox likely exists",
|
|
1826
|
+
false: "Negative verification, eligible local disposable/no-route rejection, or invalid syntax that skipped verification; check valid first",
|
|
1827
|
+
null: "Mailbox check did not complete; no verification unit is charged"
|
|
1828
|
+
},
|
|
1829
|
+
catchall: {
|
|
1830
|
+
true: "Domain accepts all addresses; an individual mailbox is not established",
|
|
1831
|
+
false: "Not classified as catchall, including invalid input and local rejection where no mailbox probe ran",
|
|
1832
|
+
null: "Mailbox check did not complete"
|
|
1833
|
+
}
|
|
1834
|
+
},
|
|
1835
|
+
billing: {
|
|
1836
|
+
pooled_requests_per_success: 1,
|
|
1837
|
+
metered: {
|
|
1838
|
+
name: "email",
|
|
1839
|
+
when: "A valid-syntax eligible mailbox check completes.",
|
|
1840
|
+
units_per_completed_check: 1,
|
|
1841
|
+
cache_hits_bill_units: true,
|
|
1842
|
+
incomplete_check_units: 0,
|
|
1843
|
+
eligible_local_negative_check_units: 1,
|
|
1844
|
+
invalid_syntax_check_units: 0,
|
|
1845
|
+
locked_deep_check_units: 0
|
|
1846
|
+
},
|
|
1847
|
+
monetary_quote: null,
|
|
1848
|
+
account_state: "unknown; included balance, on-demand access, accepted rates and spend cap require account state"
|
|
1849
|
+
},
|
|
1850
|
+
access: {
|
|
1851
|
+
api_key_required: true,
|
|
1852
|
+
key_types: [
|
|
1853
|
+
"secret",
|
|
1854
|
+
"public"
|
|
1855
|
+
],
|
|
1856
|
+
key_fences: {
|
|
1857
|
+
public: "Allowed browser origin required",
|
|
1858
|
+
app: "Allowed X-App-Id required"
|
|
1859
|
+
},
|
|
1860
|
+
effective_access: null,
|
|
1861
|
+
effective_access_status: "not_checked; key fences, account access, quotas and spending controls still apply"
|
|
1862
|
+
},
|
|
1863
|
+
retry: {
|
|
1864
|
+
client: "javascript_sdk_and_mcp",
|
|
1865
|
+
default_retries: 0,
|
|
1866
|
+
retry_http_statuses: [
|
|
1867
|
+
429,
|
|
1868
|
+
500,
|
|
1869
|
+
502,
|
|
1870
|
+
503,
|
|
1871
|
+
504
|
|
1872
|
+
],
|
|
1873
|
+
retry_network_errors: true,
|
|
1874
|
+
successful_unknown_retried: false,
|
|
1875
|
+
guidance: "Do not infer a retry from null. Repeated completed checks consume additional verification units; a transport failure does not prove the previous attempt was unbilled. DNS failures can return 503 before mailbox verification."
|
|
1876
|
+
},
|
|
1877
|
+
docs: {
|
|
1878
|
+
help: "https://api.parseapi.com/version/2.1.0/email/help",
|
|
1879
|
+
guide: "https://parseapi.com/docs/email"
|
|
1880
|
+
}
|
|
2029
1881
|
}
|
|
2030
1882
|
}
|
|
2031
1883
|
};
|
|
@@ -2249,7 +2101,7 @@ function registerBulk(server, key, transport) {
|
|
|
2249
2101
|
// package.json
|
|
2250
2102
|
var package_default = {
|
|
2251
2103
|
name: "parseapi-mcp",
|
|
2252
|
-
version: "1.
|
|
2104
|
+
version: "1.13.0",
|
|
2253
2105
|
mcpName: "com.parseapi/mcp",
|
|
2254
2106
|
description: "Official ParseAPI MCP server. Look up places, addresses, company numbers, email, phone, weather, dates and more.",
|
|
2255
2107
|
keywords: [
|
|
@@ -2299,7 +2151,7 @@ var package_default = {
|
|
|
2299
2151
|
dependencies: {
|
|
2300
2152
|
"@modelcontextprotocol/node": "^2.0.0",
|
|
2301
2153
|
"@modelcontextprotocol/server": "^2.0.0",
|
|
2302
|
-
"@parseapi/sdk": "^1.
|
|
2154
|
+
"@parseapi/sdk": "^1.14.0",
|
|
2303
2155
|
zod: "^4.0.0"
|
|
2304
2156
|
},
|
|
2305
2157
|
devDependencies: {
|
|
@@ -2314,9 +2166,9 @@ var package_default = {
|
|
|
2314
2166
|
|
|
2315
2167
|
// src/registry.ts
|
|
2316
2168
|
var VERSION = package_default.version;
|
|
2317
|
-
var API_VERSION = "2.
|
|
2169
|
+
var API_VERSION = "2.1.0";
|
|
2318
2170
|
var AU_POSTAL_NOTICE = "Incorporates or developed using G-NAF \xA9 Geoscape Australia licensed by the Commonwealth of Australia under the Open Geo-coded National Address File (G-NAF) End User Licence Agreement. Geographic choices are not mailing-address verification. Source, adaptations and licence: https://parseapi.com/legal/attribution#postal-au";
|
|
2319
|
-
var deep = z5.boolean().optional().describe("
|
|
2171
|
+
var deep = z5.boolean().optional().describe("Legacy profile request flag. API 2.1 paid plans include profile detail automatically. Existing access rules and explicit metered operations remain unchanged.");
|
|
2320
2172
|
var lat = z5.number().min(-90).max(90).describe("Latitude in decimal degrees");
|
|
2321
2173
|
var lon = z5.number().min(-180).max(180).describe("Longitude in decimal degrees");
|
|
2322
2174
|
var iso2 = (what) => z5.string().describe(`ISO 3166-1 alpha-2 ${what}, e.g. US`);
|
|
@@ -2329,7 +2181,6 @@ var titleWords = {
|
|
|
2329
2181
|
mx: "MX",
|
|
2330
2182
|
iban: "IBAN",
|
|
2331
2183
|
naics: "NAICS",
|
|
2332
|
-
bin: "BIN",
|
|
2333
2184
|
us: "US",
|
|
2334
2185
|
ach: "ACH",
|
|
2335
2186
|
url: "URL",
|
|
@@ -2344,8 +2195,8 @@ var cityScope = {
|
|
|
2344
2195
|
var cityAliases = z5.boolean().optional().describe("Match reviewed normalized aliases. Compatibility characters, case and whitespace normalize; native marks and accents remain. No spelling guesses. Requires foundation readiness.");
|
|
2345
2196
|
var cityAmbiguity = z5.literal("error").optional().describe("Reject an exact name or nearby anchor matching multiple eligible places with HTTP 409 ambiguous_city and bounded candidate identities. Add filters or choose a stable id from city_search.");
|
|
2346
2197
|
var cityRomanized = z5.boolean().optional().describe("Include a reviewed official romanized name and its language. No ASCII-folding fallback; missing or conflicting forms are null.");
|
|
2347
|
-
var cityResourceResponse = { romanized: cityRomanized
|
|
2348
|
-
var cityListResponse = { romanized: cityRomanized
|
|
2198
|
+
var cityResourceResponse = { romanized: cityRomanized };
|
|
2199
|
+
var cityListResponse = { romanized: cityRomanized };
|
|
2349
2200
|
var citySort = (terms) => z5.string().min(1).max(100).regex(new RegExp(`^[+-]?(${terms.join("|")})(,[+-]?(${terms.join("|")}))*$`)).optional().describe("Comma-separated sort terms. Prefix a term with + or - for its direction. Stable ids break ties; unknown values sort last.");
|
|
2350
2201
|
var cityCodeList = z5.union([z5.string().min(2).max(149), z5.array(z5.string().regex(/^[a-zA-Z]{2}$/)).min(1).max(50)]).optional();
|
|
2351
2202
|
var cityCollectionFilters = {
|
|
@@ -2355,10 +2206,8 @@ var cityCollectionFilters = {
|
|
|
2355
2206
|
max_elevation: z5.number().finite().optional().describe("Maximum stored elevation in meters. Unknown values do not match."),
|
|
2356
2207
|
countries: cityCodeList.describe("Include ISO2 countries, as CSV or an array. Intersects with a single country filter; on named nearby, country selects the anchor."),
|
|
2357
2208
|
exclude_countries: cityCodeList.describe("Exclude ISO2 countries, as CSV or an array."),
|
|
2358
|
-
timezones: z5.union([z5.string().min(1).max(5049), z5.array(z5.string().min(1).max(100)).min(1).max(50)]).optional().describe("Include exact IANA timezones, as CSV or an array.
|
|
2359
|
-
timezone: z5.string().optional().describe("Exact IANA timezone filter, e.g. Europe/Vienna."),
|
|
2209
|
+
timezones: z5.union([z5.string().min(1).max(5049), z5.array(z5.string().min(1).max(100)).min(1).max(50)]).optional().describe("Include exact IANA timezones, as CSV or an array."),
|
|
2360
2210
|
bbox: z5.string().optional().describe("Stored-center bounds as west,south,east,north in degrees. West greater than east crosses the date line."),
|
|
2361
|
-
order: z5.enum(["asc", "desc"]).optional().describe("Sort direction; default asc except population defaults to desc. Stable ids break ties."),
|
|
2362
2211
|
cursor: z5.string().optional().describe("Opaque continuation cursor. Reuse with exactly the same query, filters, limit, display language, Deep, hierarchy and origin.")
|
|
2363
2212
|
};
|
|
2364
2213
|
var cityPage = z5.boolean().optional().describe("Opt into next_cursor on search or named-nearby collections. A cursor also enables paging.");
|
|
@@ -2371,13 +2220,10 @@ function cityCollectionArguments(args) {
|
|
|
2371
2220
|
countries: args.countries,
|
|
2372
2221
|
excludeCountries: args.exclude_countries,
|
|
2373
2222
|
timezones: args.timezones,
|
|
2374
|
-
timezone: args.timezone,
|
|
2375
2223
|
bbox: args.bbox,
|
|
2376
2224
|
sort: args.sort,
|
|
2377
|
-
order: args.order,
|
|
2378
2225
|
page: args.page || void 0,
|
|
2379
2226
|
cursor: args.cursor,
|
|
2380
|
-
format: args.format,
|
|
2381
2227
|
romanized: args.romanized || void 0
|
|
2382
2228
|
};
|
|
2383
2229
|
}
|
|
@@ -2411,7 +2257,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
2411
2257
|
// Tool descriptions and responses share this contract on both transports.
|
|
2412
2258
|
fetch: (input, init) => {
|
|
2413
2259
|
const headers = new Headers(init?.headers);
|
|
2414
|
-
headers.set("
|
|
2260
|
+
headers.set("X-API-Version", API_VERSION);
|
|
2415
2261
|
return fetch(input, { ...init, headers });
|
|
2416
2262
|
}
|
|
2417
2263
|
}) : null;
|
|
@@ -2452,7 +2298,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
2452
2298
|
}
|
|
2453
2299
|
tool(
|
|
2454
2300
|
"ip",
|
|
2455
|
-
"Look up an IPv4 or IPv6 address: country,
|
|
2301
|
+
"Look up an IPv4 or IPv6 address: country, continent and origin ASN/operator. Paid plans automatically include supported approximate city/state, state name, postal code, latitude/longitude, timezone, routed network, ASN category and datacenter/relay/Tor/VPN/proxy flags. Unknown location values are null. ASN category is not subscriber connection technology; proxy/VPN false means unlisted.",
|
|
2456
2302
|
{ ip: z5.string().describe("IPv4 or IPv6 address, e.g. 8.8.8.8"), deep },
|
|
2457
2303
|
(c, a, request) => c.ip(a.ip, { ...request, deep: a.deep })
|
|
2458
2304
|
);
|
|
@@ -2478,8 +2324,8 @@ function buildServer(key, transport, options = {}) {
|
|
|
2478
2324
|
);
|
|
2479
2325
|
tool(
|
|
2480
2326
|
"country",
|
|
2481
|
-
"Country everyday reference: name, name_full, name_local, demonym, iso_alpha3 and iso_numeric identifiers, continent, region and subregion, currency, languages, calling code, flag, timezones, borders, bloc memberships
|
|
2482
|
-
{ code: iso2("country code"), deep: deep.describe("
|
|
2327
|
+
"Country everyday reference: name, name_full, name_local, demonym, iso_alpha3 and iso_numeric identifiers, continent, region and subregion, currency, languages, calling code, flag, timezones, borders, bloc memberships, capital object (name, latitude, longitude), postal_format guidance and postal_regex syntax checking on every plan. Postal patterns do not establish assignment or deliverability. Paid plans automatically include population, total area and national statistics (gdp_usd, gdp_per_capita_usd, population_growth_percent, urban_population_percent and internet_users_percent), geography including elevation_average in meters, and a tax reference object (name, rate) and locale conventions. Unknown values stay null.",
|
|
2328
|
+
{ code: iso2("country code"), deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.") },
|
|
2483
2329
|
(c, a, request) => c.country(a.code, { ...request, deep: a.deep })
|
|
2484
2330
|
);
|
|
2485
2331
|
tool(
|
|
@@ -2490,38 +2336,38 @@ function buildServer(key, transport, options = {}) {
|
|
|
2490
2336
|
);
|
|
2491
2337
|
tool(
|
|
2492
2338
|
"state",
|
|
2493
|
-
"Look up a state or province by code or name, with its full iso_subdivision identifier.
|
|
2339
|
+
"Look up a state or province by code or name, with its full iso_subdivision identifier. Paid plans include its demographic and tax profile automatically. Pass country to resolve a colliding code.",
|
|
2494
2340
|
{
|
|
2495
2341
|
code: z5.string().describe("State code or name, e.g. colorado, NC"),
|
|
2496
2342
|
country: countryOpt,
|
|
2497
|
-
deep: deep.describe("
|
|
2343
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2498
2344
|
},
|
|
2499
2345
|
(c, a, request) => c.state(a.code, { ...request, deep: a.deep, country: a.country })
|
|
2500
2346
|
);
|
|
2501
2347
|
tool(
|
|
2502
2348
|
"state_districts",
|
|
2503
|
-
"List the districts, counties or departments of a state.
|
|
2349
|
+
"List the districts, counties or departments of a state. Paid plans include population to each result automatically.",
|
|
2504
2350
|
{
|
|
2505
2351
|
code: z5.string().describe("State code or name, e.g. NC, colorado"),
|
|
2506
2352
|
country: countryOpt,
|
|
2507
|
-
deep: deep.describe("Include population in each district
|
|
2353
|
+
deep: deep.describe("Include population in each district on a paid plan.")
|
|
2508
2354
|
},
|
|
2509
2355
|
(c, a, request) => c.state.districts(a.code, { ...request, deep: a.deep, country: a.country })
|
|
2510
2356
|
);
|
|
2511
2357
|
tool(
|
|
2512
2358
|
"district",
|
|
2513
|
-
"Look up a district, county or department by code or name.
|
|
2359
|
+
"Look up a district, county or department by code or name. Paid plans include area, population and seat automatically. Pass state to resolve a colliding name. Paid deep property_tax contains annual_median, currency and period: median annual tax payable on owner-occupied homes in the area, adjusted to the final year of that period. It is not a rate or property bill. Unsupported, missing and censored estimates are null.",
|
|
2514
2360
|
{
|
|
2515
2361
|
code: z5.string().describe("District code or name, e.g. 37081, guilford county"),
|
|
2516
2362
|
country: countryOpt,
|
|
2517
2363
|
state: z5.string().optional().describe("ADM1 code or name to disambiguate, e.g. NC or louisiana"),
|
|
2518
|
-
deep: deep.describe("
|
|
2364
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2519
2365
|
},
|
|
2520
2366
|
(c, a, request) => c.district(a.code, { ...request, deep: a.deep, country: a.country, state: a.state })
|
|
2521
2367
|
);
|
|
2522
2368
|
tool(
|
|
2523
2369
|
"city",
|
|
2524
|
-
"Resolve a city name to coordinates, timezone and administrative context.
|
|
2370
|
+
"Resolve a city name to coordinates, timezone and administrative context. Paid plans include demographic and geographic detail automatically. Pass country or state for name ties.",
|
|
2525
2371
|
{
|
|
2526
2372
|
name: z5.string().describe("City name, e.g. charlotte"),
|
|
2527
2373
|
country: countryOpt,
|
|
@@ -2530,19 +2376,19 @@ function buildServer(key, transport, options = {}) {
|
|
|
2530
2376
|
...cityResourceResponse,
|
|
2531
2377
|
aliases: cityAliases,
|
|
2532
2378
|
ambiguity: cityAmbiguity,
|
|
2533
|
-
deep: deep.describe("
|
|
2379
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2534
2380
|
},
|
|
2535
|
-
(c, a, request) => c.city(a.name, { ...request, deep: a.deep, country: a.country, state: a.state, type: a.type, grain: a.grain, aliases: a.aliases || void 0, hierarchy: a.hierarchy || void 0, ambiguity: a.ambiguity,
|
|
2381
|
+
(c, a, request) => c.city(a.name, { ...request, deep: a.deep, country: a.country, state: a.state, type: a.type, grain: a.grain, aliases: a.aliases || void 0, hierarchy: a.hierarchy || void 0, ambiguity: a.ambiguity, romanized: a.romanized || void 0 })
|
|
2536
2382
|
);
|
|
2537
2383
|
tool(
|
|
2538
2384
|
"city_id",
|
|
2539
|
-
"Resolve a stable city id.
|
|
2540
|
-
{ id: z5.string().describe("Stable city id, e.g. city_mb8mbqrkz8zb"), ...cityResourceResponse, hierarchy: cityScope.hierarchy, deep: deep.describe("
|
|
2541
|
-
(c, a, request) => c.city.id(a.id, { ...request, deep: a.deep, hierarchy: a.hierarchy || void 0,
|
|
2385
|
+
"Resolve a stable city id. Paid plans include the city profile automatically.",
|
|
2386
|
+
{ id: z5.string().describe("Stable city id, e.g. city_mb8mbqrkz8zb"), ...cityResourceResponse, hierarchy: cityScope.hierarchy, deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.") },
|
|
2387
|
+
(c, a, request) => c.city.id(a.id, { ...request, deep: a.deep, hierarchy: a.hierarchy || void 0, romanized: a.romanized || void 0 })
|
|
2542
2388
|
);
|
|
2543
2389
|
tool(
|
|
2544
2390
|
"city_search",
|
|
2545
|
-
"Search city names. Explicit match uses the spelling search route; numeric/map/timezone/sort filters apply to default prefix search only.
|
|
2391
|
+
"Search city names. Explicit match uses the spelling search route; numeric/map/timezone/sort filters apply to default prefix search only. Paid plans include the profile inside each returned city automatically.",
|
|
2546
2392
|
{
|
|
2547
2393
|
query: z5.string().describe("City name query, e.g. char"),
|
|
2548
2394
|
match: z5.enum(["exact", "prefix", "fuzzy"]).optional().describe("Explicit matching mode; default prefix. Fuzzy results carry suggestion evidence."),
|
|
@@ -2556,19 +2402,19 @@ function buildServer(key, transport, options = {}) {
|
|
|
2556
2402
|
sort: citySort(["relevance", "name", "population", "country", "elevation"]),
|
|
2557
2403
|
page: cityPage,
|
|
2558
2404
|
limit: z5.number().int().min(1).max(50).optional().describe("Max results"),
|
|
2559
|
-
deep: deep.describe("
|
|
2405
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2560
2406
|
},
|
|
2561
2407
|
(c, a, request) => c.city.search(a.query, { ...request, deep: a.deep, country: a.country, state: a.state, limit: a.limit, match: a.match, maxDistance: a.max_distance, type: a.type, grain: a.grain, aliases: a.aliases || void 0, hierarchy: a.hierarchy || void 0, ...cityCollectionArguments(a) })
|
|
2562
2408
|
);
|
|
2563
2409
|
tool(
|
|
2564
2410
|
"city_nearest",
|
|
2565
|
-
"Find the nearest eligible stored city center within 2,000 km, with distance. Country/state/type/grain constrain candidates; this does not determine which municipality contains the point.
|
|
2411
|
+
"Find the nearest eligible stored city center within 2,000 km, with distance. Country/state/type/grain constrain candidates; this does not determine which municipality contains the point. Paid plans automatically include the profile and reviewed observation date/basis when known.",
|
|
2566
2412
|
{ lat, lon, country: countryOpt, state: z5.string().optional().describe("State code filter"), ...cityScope, ...cityResourceResponse, deep },
|
|
2567
|
-
(c, a, request) => c.city.nearest(a.lat, a.lon, { ...request, deep: a.deep, country: a.country, state: a.state, type: a.type, grain: a.grain, hierarchy: a.hierarchy || void 0,
|
|
2413
|
+
(c, a, request) => c.city.nearest(a.lat, a.lon, { ...request, deep: a.deep, country: a.country, state: a.state, type: a.type, grain: a.grain, hierarchy: a.hierarchy || void 0, romanized: a.romanized || void 0 })
|
|
2568
2414
|
);
|
|
2569
2415
|
tool(
|
|
2570
2416
|
"city_nearby",
|
|
2571
|
-
"Find nearby cities with distances.
|
|
2417
|
+
"Find nearby cities with distances. Paid plans include the profile inside each returned city automatically.",
|
|
2572
2418
|
{
|
|
2573
2419
|
name: z5.string().describe("Anchor city name, e.g. denver"),
|
|
2574
2420
|
country: countryOpt,
|
|
@@ -2583,7 +2429,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
2583
2429
|
radius: z5.number().positive().optional().describe("Search radius, default 40 km"),
|
|
2584
2430
|
unit: z5.enum(["km", "mi"]).optional().describe("Radius unit, default km"),
|
|
2585
2431
|
limit: z5.number().int().min(1).max(50).optional().describe("Max results, default 10"),
|
|
2586
|
-
deep: deep.describe("
|
|
2432
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2587
2433
|
},
|
|
2588
2434
|
(c, a, request) => c.city.nearby(a.name, {
|
|
2589
2435
|
...request,
|
|
@@ -2603,7 +2449,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
2603
2449
|
);
|
|
2604
2450
|
tool(
|
|
2605
2451
|
"city_list",
|
|
2606
|
-
"Browse the stored City catalog with filters, stable sorting and opaque cursor paging. Coverage remains curated, not worldwide.
|
|
2452
|
+
"Browse the stored City catalog with filters, stable sorting and opaque cursor paging. Coverage remains curated, not worldwide. Paid plans automatically include the profile detail within each record.",
|
|
2607
2453
|
{
|
|
2608
2454
|
country: countryOpt,
|
|
2609
2455
|
state: z5.string().optional().describe("State code filter"),
|
|
@@ -2612,13 +2458,13 @@ function buildServer(key, transport, options = {}) {
|
|
|
2612
2458
|
...cityListResponse,
|
|
2613
2459
|
sort: citySort(["name", "population", "country", "elevation"]),
|
|
2614
2460
|
limit: z5.number().int().min(1).max(50).optional().describe("Max results per page"),
|
|
2615
|
-
deep: deep.describe("
|
|
2461
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2616
2462
|
},
|
|
2617
2463
|
(c, a, request) => c.city.list({ ...request, ...cityCollectionArguments(a), country: a.country, state: a.state, type: a.type, grain: a.grain, hierarchy: a.hierarchy || void 0, limit: a.limit, deep: a.deep })
|
|
2618
2464
|
);
|
|
2619
2465
|
tool(
|
|
2620
2466
|
"city_nearby_coordinates",
|
|
2621
|
-
"List stored city centers near arbitrary coordinates, with radius, collection filters and cursor paging. The point and distances do not infer municipality containment.
|
|
2467
|
+
"List stored city centers near arbitrary coordinates, with radius, collection filters and cursor paging. The point and distances do not infer municipality containment. Paid plans automatically include the profile detail within each record.",
|
|
2622
2468
|
{
|
|
2623
2469
|
lat,
|
|
2624
2470
|
lon,
|
|
@@ -2631,7 +2477,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
2631
2477
|
unit: z5.enum(["km", "mi"]).optional().describe("Radius unit, default km"),
|
|
2632
2478
|
sort: citySort(["distance", "name", "population", "country", "elevation"]),
|
|
2633
2479
|
limit: z5.number().int().min(1).max(50).optional().describe("Max results per page"),
|
|
2634
|
-
deep: deep.describe("
|
|
2480
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2635
2481
|
},
|
|
2636
2482
|
(c, a, request) => c.city.nearbyCoordinates(a.lat, a.lon, { ...request, ...cityCollectionArguments(a), country: a.country, state: a.state, type: a.type, grain: a.grain, hierarchy: a.hierarchy || void 0, radius: a.radius, unit: a.unit, limit: a.limit, deep: a.deep })
|
|
2637
2483
|
);
|
|
@@ -2650,40 +2496,40 @@ function buildServer(key, transport, options = {}) {
|
|
|
2650
2496
|
tool("city_distance", "Great-circle kilometers and miles between two stored City centers. Unknown coordinates return null; this is not travel distance or boundary containment.", { from: cityRelationId, to: cityRelationId }, (c, a, request) => c.city.distance(a.from, a.to, request));
|
|
2651
2497
|
tool(
|
|
2652
2498
|
"postal",
|
|
2653
|
-
"Resolve a postal code to its place, coordinates and timezone. Australian core localities lists suburb choices with city, state and state_name. Null or missing means unknown, and [] means no eligible choices in the reviewed reference. A single choice can coexist with city null, so do not infer a city or a user selection. These are geographic choices, not mailing-address verification.
|
|
2499
|
+
"Resolve a postal code to its place, coordinates and timezone. Australian core localities lists suburb choices with city, state and state_name. Null or missing means unknown, and [] means no eligible choices in the reviewed reference. A single choice can coexist with city null, so do not infer a city or a user selection. These are geographic choices, not mailing-address verification. Paid plans include area, elevation, population, currency, grouped tax references, neighbors and metro associations automatically. property_tax is a nullable area statistic with annual_median in the response currency: median annual tax payable on owner-occupied homes. It is not a rate or property bill. Unsupported, missing and censored estimates are null. Tax rates are percentages and alternative geographic references, not additive.",
|
|
2654
2500
|
{
|
|
2655
2501
|
code: z5.string().describe("Postal or ZIP code, e.g. SW1A 1AA, 28202"),
|
|
2656
2502
|
country: countryOpt,
|
|
2657
|
-
deep: deep.describe("
|
|
2503
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2658
2504
|
},
|
|
2659
2505
|
(c, a, request) => c.postal(a.code, { ...request, deep: a.deep, country: a.country })
|
|
2660
2506
|
);
|
|
2661
2507
|
tool(
|
|
2662
2508
|
"postal_nearby",
|
|
2663
|
-
"Find nearby postal codes with distances.
|
|
2509
|
+
"Find nearby postal codes with distances. Paid plans include metropolitan associations to the origin and each result automatically.",
|
|
2664
2510
|
{
|
|
2665
2511
|
code: z5.string().describe("Postal code to search around"),
|
|
2666
2512
|
country: countryOpt,
|
|
2667
2513
|
radius: z5.number().positive().optional().describe("Search radius"),
|
|
2668
2514
|
unit: z5.enum(["km", "mi"]).optional().describe("Radius unit, default km"),
|
|
2669
|
-
deep: deep.describe("
|
|
2515
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2670
2516
|
},
|
|
2671
2517
|
(c, a, request) => c.postal.nearby(a.code, { ...request, deep: a.deep, country: a.country, radius: a.radius, unit: a.unit })
|
|
2672
2518
|
);
|
|
2673
2519
|
tool(
|
|
2674
2520
|
"postal_distance",
|
|
2675
|
-
"Distance between two postal codes.
|
|
2521
|
+
"Distance between two postal codes. Paid plans include metropolitan associations inside each endpoint automatically.",
|
|
2676
2522
|
{
|
|
2677
2523
|
from: z5.string().describe("First postal code"),
|
|
2678
2524
|
to: z5.string().describe("Second postal code"),
|
|
2679
2525
|
country: countryOpt,
|
|
2680
|
-
deep: deep.describe("
|
|
2526
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2681
2527
|
},
|
|
2682
2528
|
(c, a, request) => c.postal.distance(a.from, a.to, { ...request, deep: a.deep, country: a.country })
|
|
2683
2529
|
);
|
|
2684
2530
|
tool(
|
|
2685
2531
|
"address",
|
|
2686
|
-
"Look up a US or French street address: house number, street, unit, city, state, postal code and registration status. Registration does not establish deliverability or verify an apartment. Deep
|
|
2532
|
+
"Look up a US or French street address: house number, street, unit, city, state, postal code and registration status. Registration does not establish deliverability or verify an apartment. On supported US results, optional Deep includes electoral code, name and Congress number on paid plans; existing accounts retain their current Deep access.",
|
|
2687
2533
|
{
|
|
2688
2534
|
address: z5.string().describe("Street address, e.g. 1600 Pennsylvania Ave NW, Washington, DC 20500"),
|
|
2689
2535
|
country: z5.string().optional().describe("Country: US or FR. Use FR or a written France suffix for France. Defaults to US."),
|
|
@@ -2716,7 +2562,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
2716
2562
|
);
|
|
2717
2563
|
tool(
|
|
2718
2564
|
"company_id",
|
|
2719
|
-
"Look up a company directory profile by its stable co_ ID.
|
|
2565
|
+
"Look up a company directory profile by its stable co_ ID. Paid plans automatically include available legal details, identifiers, industry, business description, logo, other domains, social profiles, public business contacts, founding precision and reported employees. Employee counts retain their measurement date, organization scope and measurement basis. Reported counts may be rounded. Unavailable details are omitted; source evidence stays internal. A website claim is not legal ownership proof. National registration numbers use company.",
|
|
2720
2566
|
{ id: z5.string().min(1).describe("Stable company directory ID returned by company_search"), deep },
|
|
2721
2567
|
(c, a, request) => c.company.id(a.id, { ...request, deep: a.deep })
|
|
2722
2568
|
);
|
|
@@ -2743,15 +2589,9 @@ function buildServer(key, transport, options = {}) {
|
|
|
2743
2589
|
return selectors <= 1 && (selectors === 1 || args.country !== void 0 || args.industry !== void 0 && args.industry_type !== void 0);
|
|
2744
2590
|
}, { message: "Use at most one selector, or supply country, a complete industry pair." })
|
|
2745
2591
|
);
|
|
2746
|
-
tool(
|
|
2747
|
-
"company_coverage",
|
|
2748
|
-
"Describe the company directory edition, countries and record counts. Counts describe this edition and do not establish complete country or worldwide coverage. A missing profile does not establish that a company does not exist.",
|
|
2749
|
-
{},
|
|
2750
|
-
(c, _a, request) => c.company.coverage(request)
|
|
2751
|
-
);
|
|
2752
2592
|
tool(
|
|
2753
2593
|
"point",
|
|
2754
|
-
"Locate coordinates in their country, state, district and actual IANA timezone.
|
|
2594
|
+
"Locate coordinates in their country, state, district and actual IANA timezone. Paid plans automatically include terrain and a compact nearest-city summary with its ID and distance; existing accounts retain their current Deep access. The timezone ID stays in core. Nearest city is null when none is within 200 km.",
|
|
2755
2595
|
{ lat, lon, deep },
|
|
2756
2596
|
(c, a, request) => c.point(a.lat, a.lon, { ...request, deep: a.deep })
|
|
2757
2597
|
);
|
|
@@ -2781,42 +2621,34 @@ function buildServer(key, transport, options = {}) {
|
|
|
2781
2621
|
);
|
|
2782
2622
|
tool(
|
|
2783
2623
|
"weather",
|
|
2784
|
-
"Current weather with observation time and station distance. Paid deep adds specialist current measurements, forecast, alerts, hourly and daily outlook, air quality and optional history. Minute precipitation_rate (mm/h) and precipitation_rate_in (in/h) are rates;
|
|
2624
|
+
"Current weather with observation time and station distance. Paid deep adds specialist current measurements, forecast, alerts, hourly and daily outlook, air quality and optional history. Minute precipitation_rate (mm/h) and precipitation_rate_in (in/h) are rates; history.precipitation and precipitation_in are daily totals. Metric and imperial pairs stay together. A date requires paid deep and adds the past UTC day in history alongside current conditions.",
|
|
2785
2625
|
{
|
|
2786
2626
|
lat,
|
|
2787
2627
|
lon,
|
|
2788
2628
|
deep,
|
|
2789
|
-
date: z5.string().optional().describe("A past UTC day, YYYY-MM-DD. Requires paid deep. Adds
|
|
2629
|
+
date: z5.string().optional().describe("A past UTC day, YYYY-MM-DD. Requires paid deep. Adds history alongside current conditions.")
|
|
2790
2630
|
},
|
|
2791
2631
|
(c, a, request) => c.weather(a.lat, a.lon, { ...request, deep: a.deep, date: a.date })
|
|
2792
2632
|
);
|
|
2633
|
+
tool("email_verify", "Run an explicit metered mailbox check. Returns the complete result, including nullable deliverable, catchall, status and reason. No automatic retries by default. App keys are not allowed. A suggested first name is not verified identity.", { email: z5.string().describe("Email address to verify") }, (c, a, request) => c.email.verify(a.email, request));
|
|
2793
2634
|
tool(
|
|
2794
2635
|
"email",
|
|
2795
|
-
"Validate an email address: syntax, domain, mail routing, consumer mailbox, disposable, role, reserved domain type and typo suggestion.
|
|
2796
|
-
{ email: z5.string().describe("Email address to validate"), deep },
|
|
2636
|
+
"Validate an email address: syntax, domain, mail routing, consumer mailbox, disposable, role, reserved domain type and typo suggestion. Use email_verify for a metered mailbox check and the complete result. The basic email tool does not establish deliverability.",
|
|
2637
|
+
{ email: z5.string().describe("Email address to validate"), deep: deep.describe("Deprecated compatibility input. true runs email_verify, a metered check. Use email_verify explicitly.") },
|
|
2797
2638
|
(c, a, request) => c.email(a.email, { ...request, deep: a.deep })
|
|
2798
2639
|
);
|
|
2799
|
-
tool(
|
|
2800
|
-
"bin",
|
|
2801
|
-
"Look up a 6-11 digit payment-card prefix. Returns the actual longest matched prefix, issuer, country, brand key, brand name, card type and prepaid status where known. Unknown fields are null. Does not confirm a card or account exists. Pooled request on every plan.",
|
|
2802
|
-
{
|
|
2803
|
-
bin: z5.string().describe("Card prefix as a string, 6-11 digits. Preserve leading zeros. Spaces and hyphens are accepted."),
|
|
2804
|
-
deep: z5.boolean().optional().describe("Include an empty deep object. No extra fields or separate charge.")
|
|
2805
|
-
},
|
|
2806
|
-
(c, a, request) => c.bin(a.bin, { ...request, deep: a.deep })
|
|
2807
|
-
);
|
|
2808
2640
|
tool(
|
|
2809
2641
|
"card",
|
|
2810
|
-
"Identify a network and its CDN SVG logo from 2-11 leading digits, including processor-provided BIN/IIN prefixes. Unknown or ambiguous networks return null brand and a generic logo. Optional
|
|
2642
|
+
"Identify a network and its CDN SVG logo from 2-11 leading digits, including processor-provided BIN/IIN prefixes. Unknown or ambiguous networks return null brand and a generic logo. Optional Deep on paid plans adds the longest recorded prefix, issuer, country, funding type and nullable prepaid status; existing accounts retain their current Deep access. Core identity is independent of issuer coverage. A shorter prefix is broader coverage; missing fields never inherit from a parent row. Partial reference data does not prove card validity, account existence or payment acceptance. Core uses one pooled request on every plan. Optional Deep follows paid-plan or retained-access rules in that same request.",
|
|
2811
2643
|
{
|
|
2812
2644
|
bin: z5.string().max(64, "Send a prefix only: 2-11 digits.").regex(/^[ \t\r\n-]*(?:[0-9][ \t\r\n-]*){2,11}$/, "Send a prefix only: 2-11 digits.").describe("Processor-provided leading digits as a string, 2-11 ASCII digits. Preserve zeros. Only ASCII space, tab, CR, LF and hyphen separators; at most 64 raw characters. Never send a full card number. Six or more digits enable issuer lookup."),
|
|
2813
|
-
deep: deep.describe("Include recorded issuer details
|
|
2645
|
+
deep: deep.describe("Include recorded issuer details on paid plans in the same pooled request; existing accounts retain their current Deep access. Omitted by default; locked optional fields are absent. With access, fewer than six digits returns all-null Deep fields.")
|
|
2814
2646
|
},
|
|
2815
2647
|
(c, a, request) => c.card(a.bin, { ...request, deep: a.deep })
|
|
2816
2648
|
);
|
|
2817
2649
|
tool(
|
|
2818
2650
|
"phone",
|
|
2819
|
-
"Parse and validate a phone number with national and international display formats.
|
|
2651
|
+
"Parse and validate a phone number with national and international display formats. Paid plans automatically include numbering-plan state and timezone; existing accounts retain their current Deep access. These do not locate a handset.",
|
|
2820
2652
|
{
|
|
2821
2653
|
number: z5.string().describe("Phone number, e.g. +14155552671"),
|
|
2822
2654
|
country: iso2("country code for national-format numbers").optional(),
|
|
@@ -2826,11 +2658,11 @@ function buildServer(key, transport, options = {}) {
|
|
|
2826
2658
|
);
|
|
2827
2659
|
tool(
|
|
2828
2660
|
"carrier",
|
|
2829
|
-
"Look up current carrier,
|
|
2661
|
+
"Look up current carrier, line type and burner flag. Type uses the provider observation when mapped; otherwise it retains the numbering-plan type. The complete result includes issuing city and state when known, within the same metered lookup, including Free allowance units.",
|
|
2830
2662
|
{
|
|
2831
2663
|
number: z5.string().describe("Phone number, e.g. +14155552671"),
|
|
2832
2664
|
country: iso2("country code for national-format numbers").optional(),
|
|
2833
|
-
deep: deep.describe("
|
|
2665
|
+
deep: deep.describe("Deprecated compatibility input. The complete metered result is always returned.")
|
|
2834
2666
|
},
|
|
2835
2667
|
(c, a, request) => c.carrier(a.number, { ...request, deep: a.deep, country: a.country })
|
|
2836
2668
|
);
|
|
@@ -2845,11 +2677,11 @@ function buildServer(key, transport, options = {}) {
|
|
|
2845
2677
|
);
|
|
2846
2678
|
tool(
|
|
2847
2679
|
"hlr",
|
|
2848
|
-
"Phone status at the last check: live means assigned and connected means reachable at that check. Cached results may be returned.
|
|
2680
|
+
"Phone status at the last check: live means assigned and connected means reachable at that check. Cached results may be returned. Available roaming and network diagnostics are included in the complete metered result, including Free allowance units. Null is unconfirmed.",
|
|
2849
2681
|
{
|
|
2850
2682
|
number: z5.string().describe("Phone number, e.g. +447712345678"),
|
|
2851
2683
|
country: iso2("country code for national-format numbers").optional(),
|
|
2852
|
-
deep: deep.describe("
|
|
2684
|
+
deep: deep.describe("Deprecated compatibility input. The complete metered result is always returned.")
|
|
2853
2685
|
},
|
|
2854
2686
|
(c, a, request) => c.hlr(a.number, { ...request, deep: a.deep, country: a.country })
|
|
2855
2687
|
);
|
|
@@ -2861,7 +2693,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
2861
2693
|
);
|
|
2862
2694
|
tool(
|
|
2863
2695
|
"domain",
|
|
2864
|
-
"Check whether a domain is registered: available is true for unregistered, false for registered, and null when unknown.
|
|
2696
|
+
"Check whether a domain is registered: available is true for unregistered, false for registered, and null when unknown. Paid plans include available registration dates, registrar, status and DNSSEC automatically. Missing or null DNSSEC is unknown, while false means unsigned. Use dns for DNS records and mx for mail routing.",
|
|
2865
2697
|
{ domain: z5.string().describe("Domain name, e.g. example.com"), deep: deep.describe("Include registration details on a paid plan.") },
|
|
2866
2698
|
(c, a, request) => c.domain(a.domain, { ...request, deep: a.deep })
|
|
2867
2699
|
);
|
|
@@ -2894,40 +2726,40 @@ function buildServer(key, transport, options = {}) {
|
|
|
2894
2726
|
);
|
|
2895
2727
|
tool(
|
|
2896
2728
|
"industry",
|
|
2897
|
-
"Look up a US NAICS 2022 code, title and parent hierarchy.
|
|
2898
|
-
{ code: z5.string().describe("NAICS code, e.g. 541511 or sector range 31-33"), deep: deep.describe("
|
|
2729
|
+
"Look up a US NAICS 2022 code, title and parent hierarchy. Paid plans include definition, children and exclusions automatically.",
|
|
2730
|
+
{ code: z5.string().describe("NAICS code, e.g. 541511 or sector range 31-33"), deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.") },
|
|
2899
2731
|
(c, a, request) => c.industry(a.code, { ...request, deep: a.deep })
|
|
2900
2732
|
);
|
|
2901
2733
|
tool(
|
|
2902
2734
|
"industry_search",
|
|
2903
|
-
"Search US NAICS 2022 titles and activities. Matching text and corrections stay with the result.
|
|
2735
|
+
"Search US NAICS 2022 titles and activities. Matching text and corrections stay with the result. Paid plans include definition, children and exclusions inside each result automatically.",
|
|
2904
2736
|
{
|
|
2905
2737
|
query: z5.string().min(1).max(100).describe("Industry keywords, e.g. coffee shop"),
|
|
2906
2738
|
limit: z5.number().int().min(1).max(50).optional().describe("Maximum results, 1-50. Default 10."),
|
|
2907
|
-
deep: deep.describe("
|
|
2739
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2908
2740
|
},
|
|
2909
2741
|
(c, a, request) => c.industry.search(a.query, { ...request, deep: a.deep, limit: a.limit })
|
|
2910
2742
|
);
|
|
2911
2743
|
tool(
|
|
2912
2744
|
"naics",
|
|
2913
|
-
"Compatibility name for industry. Look up a US NAICS 2022 code, title and parent hierarchy.
|
|
2914
|
-
{ code: z5.string().describe("NAICS code, e.g. 541511 or sector range 31-33"), deep: deep.describe("
|
|
2745
|
+
"Compatibility name for industry. Look up a US NAICS 2022 code, title and parent hierarchy. Paid plans include definition, children and exclusions automatically.",
|
|
2746
|
+
{ code: z5.string().describe("NAICS code, e.g. 541511 or sector range 31-33"), deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.") },
|
|
2915
2747
|
(c, a, request) => c.industry(a.code, { ...request, deep: a.deep })
|
|
2916
2748
|
);
|
|
2917
2749
|
tool(
|
|
2918
2750
|
"naics_search",
|
|
2919
|
-
"Compatibility name for industry_search. Search US NAICS 2022 titles and activities. Matching text and corrections stay with the result.
|
|
2751
|
+
"Compatibility name for industry_search. Search US NAICS 2022 titles and activities. Matching text and corrections stay with the result. Paid plans include definition, children and exclusions inside each result automatically.",
|
|
2920
2752
|
{
|
|
2921
2753
|
query: z5.string().min(1).max(100).describe("Industry keywords, e.g. coffee shop"),
|
|
2922
2754
|
limit: z5.number().int().min(1).max(50).optional().describe("Maximum results, 1-50. Default 10."),
|
|
2923
|
-
deep: deep.describe("
|
|
2755
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2924
2756
|
},
|
|
2925
2757
|
(c, a, request) => c.industry.search(a.query, { ...request, deep: a.deep, limit: a.limit })
|
|
2926
2758
|
);
|
|
2927
2759
|
tool(
|
|
2928
2760
|
"language",
|
|
2929
2761
|
"Language names, script, writing direction, iso_alpha3 identifier and country associations.",
|
|
2930
|
-
{ code: z5.string().describe("Language code, e.g. en, ja, gsw"), deep: deep.describe("All language facts are in Core.
|
|
2762
|
+
{ code: z5.string().describe("Language code, e.g. en, ja, gsw"), deep: deep.describe("All language facts are in Core. This option does not add fields.") },
|
|
2931
2763
|
(c, a, request) => c.language(a.code, { ...request, deep: a.deep })
|
|
2932
2764
|
);
|
|
2933
2765
|
tool(
|
|
@@ -2937,13 +2769,13 @@ function buildServer(key, transport, options = {}) {
|
|
|
2937
2769
|
name: z5.string().describe("The name to parse, e.g. Smith, John or BILLY OSHALL"),
|
|
2938
2770
|
country: z5.string().optional().describe("ISO2 country context for gender, e.g. IT"),
|
|
2939
2771
|
name_locale: z5.string().min(2).max(64).optional().describe("Name-formatting locale, e.g. en or ja. Defaults to en. Changes formatting only, not parsing or gender evidence."),
|
|
2940
|
-
deep: deep.describe("
|
|
2772
|
+
deep: deep.describe("Compatibility flag; paid plans include this profile detail automatically.")
|
|
2941
2773
|
},
|
|
2942
2774
|
(c, a, request) => c.name(a.name, { ...request, deep: a.deep, country: a.country, name_locale: a.name_locale })
|
|
2943
2775
|
);
|
|
2944
2776
|
tool(
|
|
2945
2777
|
"time",
|
|
2946
|
-
"Current local time, Unix seconds, exact offset and DST. Use an IANA zone, both coordinates, or one explicit IP, city, country, airport, port or address selector. Omit all for UTC. Ambiguous or missing locations return null clock fields with location candidates; never choose a candidate for the user. to or targets converts one instant.
|
|
2778
|
+
"Current local time, Unix seconds, exact offset and DST. Use an IANA zone, both coordinates, or one explicit IP, city, country, airport, port or address selector. Omit all for UTC. Resolved place lookups include a compact location with the matched identity and coordinates. Ambiguous or missing locations return null clock fields with location candidates; never choose a candidate for the user. to or targets converts one instant. Paid plans automatically include actual wall-time resolution, standard/seasonal offsets and DST-season transitions; existing accounts retain their current Deep access.",
|
|
2947
2779
|
{
|
|
2948
2780
|
timezone: z5.string().min(1).refine((zone) => !["zones", "help"].includes(zone.trim().toLowerCase()), { message: "Time source must be an IANA timezone ID. Use time_zones to list IDs." }).optional().describe("IANA timezone, e.g. America/New_York. Omit for UTC when all source selectors are absent"),
|
|
2949
2781
|
lat: lat.optional(),
|
|
@@ -2960,7 +2792,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
2960
2792
|
disambiguation: z5.enum(["compatible", "earlier", "later", "reject"]).optional().describe("For offsetless at with to or targets at a clock change. Default compatible chooses the earlier repeated time or advances a skipped time. earlier and later choose the respective instant. For user-entered appointments prefer reject: repeated times return ambiguous_time and skipped times nonexistent_time. Ask for an explicit offset or earlier/later choice. Deep resolution explains a successful choice. Explicit offsets select the instant directly."),
|
|
2961
2793
|
targets: z5.array(z5.string().trim().min(1).max(64).refine((zone) => !zone.includes(","), { message: "Pass one timezone ID per target." })).min(1).max(10).optional().describe("Destination IANA IDs, preserving order and duplicates. Use instead of to. All targets share one instant. An unresolved or ambiguous source returns targets null."),
|
|
2962
2794
|
to: z5.string().min(1).optional().describe("Destination IANA timezone, e.g. Asia/Tokyo. Returns to.at and to.unix at the same instant"),
|
|
2963
|
-
deep: deep.describe("
|
|
2795
|
+
deep: deep.describe("Compatibility flag; paid plans include profile detail automatically. Existing accounts retain their access; unavailable fields are absent.")
|
|
2964
2796
|
},
|
|
2965
2797
|
(c, a, request) => a.lat !== void 0 && a.lon !== void 0 ? c.time.at(a.lat, a.lon, { ...request, deep: a.deep, at: a.at, to: a.to, targets: a.targets, disambiguation: a.disambiguation }) : c.time(a.timezone, { ...request, ip: a.ip, city: a.city, country: a.country, state: a.state, iata: a.iata, icao: a.icao, unlocode: a.unlocode, address: a.address, deep: a.deep, at: a.at, to: a.to, targets: a.targets, disambiguation: a.disambiguation }),
|
|
2966
2798
|
(schema) => schema.refine(
|
|
@@ -3016,16 +2848,16 @@ function buildServer(key, transport, options = {}) {
|
|
|
3016
2848
|
);
|
|
3017
2849
|
tool(
|
|
3018
2850
|
"date",
|
|
3019
|
-
"Parse a date to ISO date, validity and Unix midnight. Ambiguous numeric dates need format. to adds signed days between; omit date for UTC today.
|
|
2851
|
+
"Parse a date to ISO date, validity and Unix midnight. Ambiguous numeric dates need format. to adds signed days between; omit date for UTC today. Paid plans automatically include calendar details; existing accounts retain their current Deep access.",
|
|
3020
2852
|
{
|
|
3021
2853
|
date: z5.string().min(1).optional().describe("The date as you have it, any common format. Omit for today (UTC)"),
|
|
3022
2854
|
format: z5.enum(["mdy", "dmy"]).optional().describe("Breaks the month-first / day-first tie on numeric dates like 03/04/2026"),
|
|
3023
2855
|
to: z5.string().optional().describe("Another date. Appends to (normalized ISO) and days (signed days between)"),
|
|
3024
|
-
deep: deep.describe("
|
|
2856
|
+
deep: deep.describe("Compatibility flag; paid plans include profile detail automatically. Existing accounts retain their access; unavailable fields are absent.")
|
|
3025
2857
|
},
|
|
3026
2858
|
(c, a, request) => {
|
|
3027
2859
|
if (a.date == null) return c.date.today({ ...request, deep: a.deep, to: a.to });
|
|
3028
|
-
return c.date(a.date, { ...request,
|
|
2860
|
+
return c.date(a.date, { ...request, format: a.format, deep: a.deep, to: a.to });
|
|
3029
2861
|
},
|
|
3030
2862
|
(schema) => schema.refine(
|
|
3031
2863
|
(a) => a.format === void 0 || a.date !== void 0,
|
|
@@ -3049,8 +2881,8 @@ function buildServer(key, transport, options = {}) {
|
|
|
3049
2881
|
);
|
|
3050
2882
|
tool(
|
|
3051
2883
|
"emoji",
|
|
3052
|
-
'Resolve an emoji character, shortcode, name or codepoint sequence.
|
|
3053
|
-
{ emoji: z5.string().describe("Emoji input, e.g. rocket, :rocket:, \u{1F680} or U+1F680"), shortcode_source: z5.enum(["cldr", "github", "slack", "discord"]).optional().describe("Resolve the shortcode within this source."), deep: deep.describe("
|
|
2884
|
+
'Resolve an emoji character, shortcode, name or codepoint sequence. Paid plans automatically include encoding, keywords, tone relationships and artwork; existing accounts retain their current Deep access. Artwork is keyed by style: artwork.openmoji.svg and artwork.openmoji.png["72"].',
|
|
2885
|
+
{ emoji: z5.string().describe("Emoji input, e.g. rocket, :rocket:, \u{1F680} or U+1F680"), shortcode_source: z5.enum(["cldr", "github", "slack", "discord"]).optional().describe("Resolve the shortcode within this source."), deep: deep.describe("Compatibility flag; paid plans include profile detail automatically. Existing accounts retain their access; unavailable fields are absent.") },
|
|
3054
2886
|
(c, a, request) => c.emoji(a.emoji, { ...request, deep: a.deep, shortcodeSource: a.shortcode_source })
|
|
3055
2887
|
);
|
|
3056
2888
|
tool(
|
|
@@ -3068,29 +2900,20 @@ function buildServer(key, transport, options = {}) {
|
|
|
3068
2900
|
emojiFilters,
|
|
3069
2901
|
(c, a, request) => c.emoji.browse({ ...request, ...a, maxVersion: a.max_version, includeSkinTones: a.include_skin_tones })
|
|
3070
2902
|
);
|
|
3071
|
-
tool(
|
|
3072
|
-
"emoji_metadata",
|
|
3073
|
-
"Get actual emoji inventory total, content edition, completeness, required notices and artwork coverage. Artwork notice files are linked; data notices travel with the snapshot. One pooled read.",
|
|
3074
|
-
{},
|
|
3075
|
-
async (c, _a, request) => c.emoji.metadata(request)
|
|
3076
|
-
);
|
|
3077
2903
|
tool(
|
|
3078
2904
|
"emoji_catalog",
|
|
3079
|
-
"Get
|
|
2905
|
+
"Get the JSON catalog download URL. Download it with your API key; the catalog carries inventory and required notices. This tool makes no API request.",
|
|
3080
2906
|
{
|
|
3081
2907
|
category: emojiFilters.category,
|
|
3082
2908
|
subcategory: emojiFilters.subcategory,
|
|
3083
2909
|
version: emojiFilters.version,
|
|
3084
2910
|
max_version: emojiFilters.max_version,
|
|
3085
|
-
include_skin_tones: emojiFilters.include_skin_tones
|
|
3086
|
-
profile: z5.enum(["full", "compact"]).optional().describe("JSON download profile. Compact retains offline lookup, search and parse facts while omitting bulky artwork details.")
|
|
2911
|
+
include_skin_tones: emojiFilters.include_skin_tones
|
|
3087
2912
|
},
|
|
3088
2913
|
async (c, a, request) => {
|
|
3089
|
-
const metadata = await c.emoji.metadata(request);
|
|
3090
2914
|
const url = new URL("https://api.parseapi.com/emoji/catalog");
|
|
3091
2915
|
for (const [key2, value] of Object.entries({ category: a.category, subcategory: a.subcategory, version: a.version, max_version: a.max_version, include_skin_tones: a.include_skin_tones, lang: request.lang })) if (value !== void 0) url.searchParams.set(key2, String(value));
|
|
3092
|
-
|
|
3093
|
-
return { metadata, download_url: url.href };
|
|
2916
|
+
return { download_url: url.href };
|
|
3094
2917
|
}
|
|
3095
2918
|
);
|
|
3096
2919
|
tool(
|
|
@@ -3102,7 +2925,7 @@ function buildServer(key, transport, options = {}) {
|
|
|
3102
2925
|
tool(
|
|
3103
2926
|
"emoji_parse",
|
|
3104
2927
|
"Extract complete Unicode emoji sequences from text. Results group repeated emoji in first-occurrence order, and positions use UTF-16 code units with an exclusive end. Text is sent in the POST body.",
|
|
3105
|
-
{ text: z5.string().max(16e3).describe("Text to inspect for native Unicode emoji, up to 16000 UTF-16 code units."), deep: deep.describe("
|
|
2928
|
+
{ text: z5.string().max(16e3).describe("Text to inspect for native Unicode emoji, up to 16000 UTF-16 code units."), deep: deep.describe("Compatibility flag; paid plans include reference detail inside each result automatically.") },
|
|
3106
2929
|
(c, a, request) => c.emoji.parse(a.text, { ...request, deep: a.deep })
|
|
3107
2930
|
);
|
|
3108
2931
|
tool(
|
|
@@ -3113,9 +2936,9 @@ function buildServer(key, transport, options = {}) {
|
|
|
3113
2936
|
);
|
|
3114
2937
|
tool(
|
|
3115
2938
|
"currency",
|
|
3116
|
-
"Currency
|
|
3117
|
-
{ code: z5.string().describe("ISO 4217 code, e.g. USD") },
|
|
3118
|
-
(c, a, request) => c.currency(a.code, request)
|
|
2939
|
+
"Currency name, symbols, decimal places and iso_numeric identifier. Paid plans include plural name and using countries automatically.",
|
|
2940
|
+
{ code: z5.string().describe("ISO 4217 code, e.g. USD"), deep: deep.describe("Compatibility option; Currency already includes its complete reference on every plan.") },
|
|
2941
|
+
(c, a, request) => c.currency(a.code, { ...request, deep: a.deep })
|
|
3119
2942
|
);
|
|
3120
2943
|
tool(
|
|
3121
2944
|
"currency_rate",
|