/** * Standardised Parameter Descriptions for MCP Tools * * DESIGN GOAL: Reduce token usage by using short, consistent descriptions. * Each description should be ≤10 words. * * USAGE: Import and use in tool schema definitions: * import { PARAMS } from '../../../core/param-descriptions.js'; * description: PARAMS.QUERY */ export declare const PARAMS: { readonly QUERY: "Search terms"; readonly QUERY_OPTIONAL: "Search terms (optional)"; readonly LIMIT: "Max results (1-100)"; readonly LIMIT_1000: "Max results (1-1000)"; readonly OFFSET: "Skip N results"; readonly PAGE: "Page number (1-based)"; readonly DATE_FROM: "Start date (YYYY or YYYY-MM-DD)"; readonly DATE_TO: "End date (YYYY or YYYY-MM-DD)"; readonly YEAR: "Year filter"; readonly YEAR_FROM: "Start year (e.g., 2020)"; readonly YEAR_TO: "End year (e.g., 2024)"; readonly DECADE: "Decade filter (e.g., \"199\" for 1990s)"; readonly STATE: "Australian state/territory"; readonly STATE_FULL: "State (full name)"; readonly LGA: "Local Government Area"; readonly BBOX: "Bounding box: minLon,minLat,maxLon,maxLat"; readonly MUNICIPALITY: "Municipality name"; readonly LAT: "Centre latitude (-90 to 90)"; readonly LON: "Centre longitude (-180 to 180)"; readonly RADIUS_KM: "Search radius in kilometres"; readonly ID: "Record ID"; readonly ID_NUMERIC: "Numeric record ID"; readonly SERIES: "VPRS series number"; readonly AGENCY: "VA agency number"; readonly NUC: "NUC code (e.g., VSL, ANL)"; readonly GUID: "Species GUID"; readonly WORK_ID: "Work ID"; readonly LIST_ID: "List ID"; readonly LAYER_ID: "Layer ID"; readonly MANIFEST_URL: "IIIF manifest URL"; readonly DIGITISED_ONLY: "Digitised records only"; readonly HAS_IMAGES: "Records with images only"; readonly SCANNED_ONLY: "Scanned records only"; readonly ON_DISPLAY: "Items on display only"; readonly RANDOM: "Random order"; readonly FUZZY: "Fuzzy matching"; readonly AUSTRALIAN: "Australian content only"; readonly FIRST_NATIONS: "First Nations content only"; readonly SPATIALLY_VALID: "Valid coordinates only"; readonly INCLUDE_FULL_TEXT: "Include full text"; readonly INCLUDE_HOLDINGS: "Include library holdings"; readonly INCLUDE_LINKS: "Include external links"; readonly INCLUDE_YEARS: "Include available years"; readonly INCLUDE_ITEMS: "Include list items"; readonly INCLUDE_CANVASES: "Include canvas/image details"; readonly CATEGORY: "Content category"; readonly RECORD_TYPE: "Record type"; readonly RECORD_FORM: "Record form/format"; readonly WORK_TYPE: "Work type filter"; readonly FORMAT: "Format filter"; readonly TYPE: "Type filter"; readonly ILLUSTRATION_TYPE: "Illustrated or Not Illustrated"; readonly AVAILABILITY: "Online availability"; readonly LANGUAGE: "Language filter"; readonly SCIENTIFIC_NAME: "Scientific name"; readonly VERNACULAR_NAME: "Common name"; readonly KINGDOM: "Taxonomic kingdom"; readonly FAMILY: "Taxonomic family"; readonly GENUS: "Genus name"; readonly TAXON: "Taxonomic classification"; readonly BASIS_OF_RECORD: "How recorded (specimen, observation)"; readonly COORDINATE_UNCERTAINTY: "Max coord uncertainty in metres"; readonly OCCURRENCE_STATUS: "present or absent"; readonly DATA_RESOURCE_NAME: "Contributing dataset name"; readonly COLLECTOR: "Collector name"; readonly CREATOR: "Author/creator name"; readonly SUBJECT: "Subject term"; readonly ISBN: "ISBN"; readonly ISSN: "ISSN"; readonly SORT_BY: "Sort order"; readonly SORT_BY_RELEVANCE: "Sort: relevance, datedesc, dateasc"; readonly START_FROM: "Starting offset"; readonly MAX_RECORDS: "Max records (1-1000)"; readonly CURSOR: "Pagination cursor"; readonly IMAGE_SERVICE_URL: "IIIF Image API base URL"; readonly REGION: "Image region (full, square, x,y,w,h)"; readonly SIZE: "Image size (max, !w,h, pct:n)"; readonly ROTATION: "Rotation degrees"; readonly QUALITY: "Image quality"; readonly IMAGE_FORMAT: "Output format (jpg, png, etc.)"; readonly PAGES: "Page range (e.g., \"1-5\", \"1,3,7\")"; readonly MAX_CANVASES: "Max canvases to include"; readonly FILM_NUMBER: "Film number (e.g., MAP2080)"; readonly RUN: "Run identifier"; readonly FRAME: "Frame identifier"; readonly OBJECT_ID: "ArcGIS OBJECTID"; readonly PRIME_MINISTER: "PM name (partial match)"; readonly TRANSCRIPT_ID: "Transcript ID (1-26000)"; readonly ARCHITECTURAL_STYLE: "Architectural style"; readonly ARCH_STYLE: "Architectural style"; readonly PERIOD: "Historical period"; readonly THEME: "Heritage theme (from vhd_list_themes)"; readonly COLLECTION: "Collection name"; readonly START_PAGE: "Starting page number"; readonly INCLUDE: "Data to include"; readonly RECLEVEL: "Detail level (brief/full)"; readonly PARTY_ID: "Person/organisation ID"; readonly MEDIA_ID: "Media ID"; readonly PLACE_ID: "Place ID"; readonly CONSTELLATION_ID: "Constellation ID"; readonly CREATOR_ID: "Creator ID"; readonly IMAGE_SIZE: "Image size (thumbnail, medium, full)"; readonly INCLUDE_FACETS: "Include facet counts"; readonly FACET_FIELDS: "Facets to return"; readonly FACET_LIMIT: "Max values per facet"; }; export type ParamKey = keyof typeof PARAMS; export declare const ENUM_DESC: { readonly TROVE_CATEGORY: "all, newspaper, gazette, magazine, image, book, etc."; readonly TROVE_SORT: "relevance, datedesc, dateasc"; readonly TROVE_AVAILABILITY: "online, free, restricted, subscription"; readonly AU_STATE_ABBREV: "vic, nsw, qld, sa, wa, tas, nt, act"; readonly AU_STATE_FULL: "Victoria, New South Wales, Queensland, etc."; readonly VHD_STYLE: "Victorian Period, Federation Period, etc."; readonly VHD_PERIOD: "Historical period classification"; readonly ACMI_TYPE: "Film, Television, Videogame, Artwork, etc."; readonly ALA_KINGDOM: "Animalia, Plantae, Fungi, etc."; readonly IIIF_SIZE: "max, full, !w,h, pct:n, w, or ,h"; readonly IIIF_FORMAT: "jpg, png, gif, webp, tif"; readonly IIIF_QUALITY: "default, color, gray, bitonal"; readonly IMAGE_SIZE: "thumbnail, medium, full, all"; readonly PROV_RECORD_FORM: "Photograph, Map, File, etc."; readonly PROV_CATEGORY: "agency, function, series, item, image"; readonly MV_RECORD_TYPE: "article, item, species, specimen"; readonly MV_CATEGORY: "natural sciences, first peoples, history"; readonly MV_LICENCE: "public domain, cc by, cc by-nc, etc."; }; //# sourceMappingURL=param-descriptions.d.ts.map