ris-mcp-ts 1.7.0 → 1.8.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.
Files changed (39) hide show
  1. package/README.md +23 -11
  2. package/dist/generated/trefferliste-html.d.ts.map +1 -1
  3. package/dist/generated/trefferliste-html.js +1 -1
  4. package/dist/generated/trefferliste-html.js.map +1 -1
  5. package/dist/helpers.d.ts +11 -2
  6. package/dist/helpers.d.ts.map +1 -1
  7. package/dist/helpers.js +17 -6
  8. package/dist/helpers.js.map +1 -1
  9. package/dist/structured-search.d.ts +72 -0
  10. package/dist/structured-search.d.ts.map +1 -0
  11. package/dist/structured-search.js +138 -0
  12. package/dist/structured-search.js.map +1 -0
  13. package/dist/tools/bezirke.js +1 -1
  14. package/dist/tools/bezirke.js.map +1 -1
  15. package/dist/tools/bundesgesetzblatt.js +1 -1
  16. package/dist/tools/bundesgesetzblatt.js.map +1 -1
  17. package/dist/tools/bundesrecht.js +1 -1
  18. package/dist/tools/bundesrecht.js.map +1 -1
  19. package/dist/tools/gemeinden.js +1 -1
  20. package/dist/tools/gemeinden.js.map +1 -1
  21. package/dist/tools/history.js +1 -1
  22. package/dist/tools/history.js.map +1 -1
  23. package/dist/tools/judikatur.js +1 -1
  24. package/dist/tools/judikatur.js.map +1 -1
  25. package/dist/tools/landesgesetzblatt.js +1 -1
  26. package/dist/tools/landesgesetzblatt.js.map +1 -1
  27. package/dist/tools/landesrecht.js +1 -1
  28. package/dist/tools/landesrecht.js.map +1 -1
  29. package/dist/tools/regierungsvorlagen.js +1 -1
  30. package/dist/tools/regierungsvorlagen.js.map +1 -1
  31. package/dist/tools/sonstige.js +1 -1
  32. package/dist/tools/sonstige.js.map +1 -1
  33. package/dist/tools/verordnungen.js +1 -1
  34. package/dist/tools/verordnungen.js.map +1 -1
  35. package/dist/types.d.ts +48 -11
  36. package/dist/types.d.ts.map +1 -1
  37. package/dist/types.js +26 -2
  38. package/dist/types.js.map +1 -1
  39. package/package.json +1 -1
package/README.md CHANGED
@@ -225,7 +225,7 @@ Search Austrian federal laws such as ABGB, StGB, UGB, and more.
225
225
  | `applikation` | string | "BrKons" (consolidated, default), "Begut" (drafts), "BgblAuth" (gazette), "Erv" (English translations) |
226
226
  | `fassung_vom` | string | Date for historical version (YYYY-MM-DD) |
227
227
  | `seite` | number | Page number (default: 1) |
228
- | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20) |
228
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
229
229
  | `response_format` | string | "markdown" (default) or "json" |
230
230
 
231
231
  All parameters are optional. At least one search parameter (`suchworte`, `titel`, or `paragraph`) should be provided.
@@ -252,7 +252,7 @@ Search state laws of the nine Austrian provinces.
252
252
  | `gesetzesnummer` | string | Exact law number (Gesetzesnummer) of a specific state law |
253
253
  | `applikation` | string | "LrKons" (consolidated, default) |
254
254
  | `seite` | number | Page number |
255
- | `limit` | number | Results per page |
255
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
256
256
  | `response_format` | string | "markdown" or "json" |
257
257
 
258
258
  </details>
@@ -280,7 +280,7 @@ Search court decisions from Austrian courts.
280
280
  | `entscheidungsdatum_bis` | string | Decision date to (YYYY-MM-DD) |
281
281
  | `sortierung` | string | Sort by decision date: "datum_auf" (oldest first) or "datum_ab" (newest first) |
282
282
  | `seite` | number | Page number |
283
- | `limit` | number | Results per page |
283
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
284
284
  | `response_format` | string | "markdown" or "json" |
285
285
 
286
286
  **Available `gerichtsbarkeit` values (16):**
@@ -322,7 +322,7 @@ Search the Federal Law Gazette (BGBl) — official publications of federal legis
322
322
  | `titel` | string | Search in titles |
323
323
  | `applikation` | string | "BgblAuth" (authentic from 2004, default), "BgblPdf" (PDF), "BgblAlt" (1945–2003) |
324
324
  | `seite` | number | Page number |
325
- | `limit` | number | Results per page |
325
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
326
326
  | `response_format` | string | "markdown" or "json" |
327
327
 
328
328
  </details>
@@ -343,7 +343,7 @@ Search State Law Gazettes (LGBl) — official publications of state legislation.
343
343
  | `titel` | string | Search in titles |
344
344
  | `applikation` | string | "LgblAuth" (authentic, default), "Lgbl" (general), "LgblNO" (Niederoesterreich) |
345
345
  | `seite` | number | Page number |
346
- | `limit` | number | Results per page |
346
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
347
347
  | `response_format` | string | "markdown" or "json" |
348
348
 
349
349
  </details>
@@ -366,7 +366,7 @@ Search government bills — draft legislation submitted to parliament.
366
366
  | `sortierung_richtung` | string | Ascending or Descending |
367
367
  | `sortierung_spalte` | string | Kurztitel, EinbringendeStelle, Beschlussdatum |
368
368
  | `seite` | number | Page number |
369
- | `limit` | number | Results per page |
369
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
370
370
  | `response_format` | string | "markdown" or "json" |
371
371
 
372
372
  </details>
@@ -428,7 +428,7 @@ Search announcements from district administrative authorities.
428
428
  | `kundmachungsdatum_bis` | string | Date to (YYYY-MM-DD) |
429
429
  | `im_ris_seit` | string | Added recently: EinerWoche, ZweiWochen, EinemMonat, DreiMonaten, SechsMonaten, EinemJahr |
430
430
  | `seite` | number | Page number |
431
- | `limit` | number | Results per page |
431
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
432
432
  | `response_format` | string | "markdown" or "json" |
433
433
 
434
434
  </details>
@@ -449,7 +449,7 @@ Search municipal law — local ordinances and regulations.
449
449
  | `applikation` | string | "Gr" (municipal law, default) or "GrA" (official gazettes) |
450
450
  | `im_ris_seit` | string | Added recently |
451
451
  | `seite` | number | Page number |
452
- | `limit` | number | Results per page |
452
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
453
453
  | `response_format` | string | "markdown" or "json" |
454
454
 
455
455
  Additional parameters depend on the selected application. See `Gr` (municipal law) and `GrA` (official gazettes) specific parameters in the source code.
@@ -472,7 +472,7 @@ Search miscellaneous legal collections and specialized databases.
472
472
  | `datum_bis` | string | Date to (YYYY-MM-DD) |
473
473
  | `im_ris_seit` | string | Added recently |
474
474
  | `seite` | number | Page number |
475
- | `limit` | number | Results per page |
475
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
476
476
  | `response_format` | string | "markdown" or "json" |
477
477
 
478
478
  **Available collections:**
@@ -506,7 +506,7 @@ Track document creation, modification, and deletion across the RIS database.
506
506
  | `aenderungen_bis` | string | Changes to date (YYYY-MM-DD) |
507
507
  | `include_deleted` | boolean | Include deleted documents (default: false) |
508
508
  | `seite` | number | Page number |
509
- | `limit` | number | Results per page |
509
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
510
510
  | `response_format` | string | "markdown" or "json" |
511
511
 
512
512
  **Available applications (36):**
@@ -537,11 +537,23 @@ Search state ordinance gazettes (Verordnungsblätter).
537
537
  | `kundmachungsdatum_von` | string | Date from (YYYY-MM-DD) |
538
538
  | `kundmachungsdatum_bis` | string | Date to (YYYY-MM-DD) |
539
539
  | `seite` | number | Page number |
540
- | `limit` | number | Results per page |
540
+ | `limit` | number | Results per page: 10, 20, 50, 100 (default: 20). Prefer 20; a page over the structured-payload budget is delivered at the next smaller size (see [Result size](#result-size)) |
541
541
  | `response_format` | string | "markdown" or "json" |
542
542
 
543
543
  </details>
544
544
 
545
+ ### Result size
546
+
547
+ The text block of every tool is capped at 25,000 characters. The search tools'
548
+ `structuredContent` has its own budget of 60,000 characters (serialized); a
549
+ page that would exceed it is delivered at the next smaller RIS page size
550
+ (100 → 50 → 20 → 10) with `page`, `page_size`, `has_more` and the `query` echo
551
+ rewritten to that size and a German `notice` in both the text and the payload.
552
+ Page with `query.limit` and `query.seite` as echoed. Prefer `limit: 20`; 50
553
+ suits a broad survey; 100 is only ever delivered when the hits are small.
554
+ Self-hosters whose client accepts larger results can raise the budget with the
555
+ `RIS_STRUCTURED_CONTENT_BUDGET` environment variable (a positive integer).
556
+
545
557
  ## Development
546
558
 
547
559
  ### Prerequisites
@@ -1 +1 @@
1
- {"version":3,"file":"trefferliste-html.d.ts","sourceRoot":"","sources":["../../src/generated/trefferliste-html.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,iBAAiB,EAAE,MAAyv6U,CAAC"}
1
+ {"version":3,"file":"trefferliste-html.d.ts","sourceRoot":"","sources":["../../src/generated/trefferliste-html.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,iBAAiB,EAAE,MAAyt6U,CAAC"}