postalref
USPS package barcodes, service type codes and mailing terms, each cited to its USPS source.
사용해야 할까요
품질 및 안전성
발견 사항 (1)
- LOWdefine에서
도구 정의와 프로토콜 준수에 대한 자동 분석을 기반으로 합니다.
컨텍스트 비용
이는 서버의 도구가 모델의 컨텍스트에 로드될 때마다 소비되는 대략적인 토큰 수입니다. 수치가 높을수록 다른 작업에 사용할 수 있는 주의가 줄어듭니다.
설치
원클릭 설치
`claude_desktop_config.json` 파일에 다음을 추가하세요:
{
"mcpServers": {
"postalref": {
"url": "https://postalref.com/mcp"
}
}
}원격 엔드포인트
https://postalref.com/mcpstreamable-http할 수 있는 일
도구 목록
도구 (7)
🟢decode(barcode)
Read a package barcode or tracking number (IMpb): its layout, each field's digits and meaning, whether the check digit holds, and the service type code's row in the USPS list, each with the passage that says so.
입력 스키마
{
"type": "object",
"properties": {
"barcode": {
"type": "string",
"maxLength": 80
}
},
"required": [
"barcode"
],
"additionalProperties": false
}출력 스키마
{
"type": "object",
"properties": {
"digits": {
"type": "string"
},
"tracking": {
"type": "string"
},
"spec": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"slug",
"name"
],
"additionalProperties": true
},
"format": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"length": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"cites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"passage": {
"type": "string"
},
"lit": {
"type": "array",
"items": {
"type": "string"
}
},
"field": {
"type": "string"
},
"at": {
"type": "string"
}
},
"required": [
"passage",
"lit"
],
"additionalProperties": true
}
}
},
"required": [
"id",
"name",
"length",
"cites"
],
"additionalProperties": true
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"name": {
"type": "string"
},
"digits": {
"type": "string"
},
"meaning": {
"type": "string"
},
"cites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"passage": {
"type": "string"
},
"lit": {
"type": "array",
"items": {
"type": "string"
}
},
"field": {
"type": "string"
},
"at": {
"type": "string"
}
},
"required": [
"passage",
"lit"
],
"additionalProperties": true
}
},
"length": {
"type": "object",
"properties": {
"passage": {
"type": "string"
},
"lit": {
"type": "array",
"items": {
"type": "string"
}
},
"field": {
"type": "string"
},
"at": {
"type": "string"
}
},
"required": [
"passage",
"lit"
],
"additionalProperties": true
},
"code": {
"type": "object",
"properties": {
"table": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"document": {
"type": "string"
},
"edition": {
"type": "string"
}
},
"required": [
"slug",
"name",
"document",
"edition"
],
"additionalProperties": true
},
"code": {
"type": "string"
},
"listed": {
"type": "boolean"
},
"removed": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"passage": {
"type": "string"
},
"revision": {
"type": "string"
},
"place": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Text"
]
},
"page": {
"type": "object",
"properties": {
"pdf": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printed": {
"type": "string"
}
},
"required": [
"pdf"
],
"additionalProperties": true
},
"section": {
"type": "string"
},
"table": {
"type": "string"
}
},
"required": [
"_tag",
"page"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"TableRow"
]
},
"page": {
"type": "object",
"properties": {
"pdf": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printed": {
"type": "string"
}
},
"required": [
"pdf"
],
"additionalProperties": true
},
"table": {
"type": "string"
}
},
"required": [
"_tag",
"page",
"table"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SheetRow"
]
},
"sheet": {
"type": "string"
},
"row": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"sheet",
"row"
],
"additionalProperties": true
}
]
},
"cells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"column",
"value"
],
"additionalProperties": true
}
},
"filled": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"from": {
"type": "string"
}
},
"required": [
"column",
"value",
"from"
],
"additionalProperties": true
}
},
"checked": {
"type": "boolean"
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"table": {
"type": "string"
},
"code": {
"type": "string"
},
"row": {
"type": "object",
"properties": {
"passage": {
"type": "string"
},
"cells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"column",
"value"
],
"additionalProperties": true
}
},
"checked": {
"type": "boolean"
}
},
"required": [
"passage",
"cells",
"checked"
],
"additionalProperties": true
},
"removed": {
"type": "string"
}
},
"required": [
"column",
"table",
"code"
],
"additionalProperties": true
}
}
},
"required": [
"passage",
"revision",
"place",
"cells",
"checked",
"references"
],
"additionalProperties": true
}
}
},
"required": [
"table",
"code",
"listed",
"rows"
],
"additionalProperties": true
}
},
"required": [
"key",
"label",
"name",
"digits",
"meaning",
"cites",
"length"
],
"additionalProperties": true
}
},
"checks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rule": {
"type": "string"
},
"outcome": {
"type": "string",
"enum": [
"pass",
"fail",
"warn"
]
},
"text": {
"type": "string"
},
"cites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"passage": {
"type": "string"
},
"lit": {
"type": "array",
"items": {
"type": "string"
}
},
"field": {
"type": "string"
},
"at": {
"type": "string"
}
},
"required": [
"passage",
"lit"
],
"additionalProperties": true
}
}
},
"required": [
"rule",
"outcome",
"text",
"cites"
],
"additionalProperties": true
}
},
"verdict": {
"type": "string",
"enum": [
"valid",
"invalid",
"unknown-code"
]
}
},
"required": [
"digits",
"tracking",
"spec",
"format",
"fields",
"checks",
"verdict"
],
"additionalProperties": true
}🟢lookup(code, table)
Look up a USPS code: its row as USPS prints it in the newest edition that lists it, the codes its cells name, the editions that list it and its history, each row with its passage id.
입력 스키마
{
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 40,
"description": "A code as USPS prints it: 055, 920, PM, 01."
},
"table": {
"type": "string",
"description": "One table to look in: stc, extra-services, mail-classes, ptr, ptr2 or stid. Every table when absent."
}
},
"required": [
"code"
],
"additionalProperties": false
}출력 스키마
{
"type": "object",
"properties": {
"matches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"table": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"document": {
"type": "string"
},
"edition": {
"type": "string"
}
},
"required": [
"slug",
"name",
"document",
"edition"
],
"additionalProperties": true
},
"code": {
"type": "string"
},
"listed": {
"type": "boolean"
},
"removed": {
"type": "string"
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"passage": {
"type": "string"
},
"revision": {
"type": "string"
},
"place": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Text"
]
},
"page": {
"type": "object",
"properties": {
"pdf": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printed": {
"type": "string"
}
},
"required": [
"pdf"
],
"additionalProperties": true
},
"section": {
"type": "string"
},
"table": {
"type": "string"
}
},
"required": [
"_tag",
"page"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"TableRow"
]
},
"page": {
"type": "object",
"properties": {
"pdf": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printed": {
"type": "string"
}
},
"required": [
"pdf"
],
"additionalProperties": true
},
"table": {
"type": "string"
}
},
"required": [
"_tag",
"page",
"table"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SheetRow"
]
},
"sheet": {
"type": "string"
},
"row": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"sheet",
"row"
],
"additionalProperties": true
}
]
},
"cells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"column",
"value"
],
"additionalProperties": true
}
},
"filled": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
},
"from": {
"type": "string"
}
},
"required": [
"column",
"value",
"from"
],
"additionalProperties": true
}
},
"checked": {
"type": "boolean"
},
"references": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"table": {
"type": "string"
},
"code": {
"type": "string"
},
"row": {
"type": "object",
"properties": {
"passage": {
"type": "string"
},
"cells": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"column",
"value"
],
"additionalProperties": true
}
},
"checked": {
"type": "boolean"
}
},
"required": [
"passage",
"cells",
"checked"
],
"additionalProperties": true
},
"removed": {
"type": "string"
}
},
"required": [
"column",
"table",
"code"
],
"additionalProperties": true
}
}
},
"required": [
"passage",
"revision",
"place",
"cells",
"checked",
"references"
],
"additionalProperties": true
}
},
"editions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"revision": {
"type": "string"
},
"place": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Text"
]
},
"page": {
"type": "object",
"properties": {
"pdf": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printed": {
"type": "string"
}
},
"required": [
"pdf"
],
"additionalProperties": true
},
"section": {
"type": "string"
},
"table": {
"type": "string"
}
},
"required": [
"_tag",
"page"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"TableRow"
]
},
"page": {
"type": "object",
"properties": {
"pdf": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printed": {
"type": "string"
}
},
"required": [
"pdf"
],
"additionalProperties": true
},
"table": {
"type": "string"
}
},
"required": [
"_tag",
"page",
"table"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"SheetRow"
]
},
"sheet": {
"type": "string"
},
"row": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"_tag",
"sheet",
"row"
],
"additionalProperties": true
}
]
},
"checked": {
"type": "boolean"
}
},
"required": [
"date",
"revision",
"place",
"checked"
],
"additionalProperties": true
}
},
"history": {
"type": "object",
"properties": {
"series": {
"type": "string"
},
"code": {
"type": "string"
},
"first": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"fid": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"how": {
"type": "string",
"enum": [
"listed",
"added"
]
},
"rows": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"required": [
"date",
"fid",
"how",
"rows"
],
"additionalProperties": true
},
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string"
},
"fid": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"change": {
"type": "string",
"enum": [
"added",
"removed",
"changed",
"retired",
"unchecked",
"disagreement"
]
},
"row": {
"type": "string"
},
"cells": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"before": {
"type": "string"
},
"after": {
"type": "string"
}
},
"required": [
"column",
"before",
"after"
],
"additionalProperties": true
}
},
"marks": {
"type": "string"
},
"diff": {
"type": "string"
}
},
"required": [
"date",
"fid",
"change"
],
"additionalProperties": true
}
}
},
"required": [
"series",
"code",
"first",
"events"
],
"additionalProperties": true
}
},
"required": [
"table",
"code",
"listed",
"rows",
"editions",
"history"
],
"additionalProperties": true
}
}
},
"required": [
"matches"
],
"additionalProperties": true
}🟢diff(subject, code, from, to, severity, ...)
What changed in a code table or document between two editions: each code added, removed or changed and each changed section, rated editorial, additive or breaking, with who rated it.
입력 스키마
{
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "A code table, such as stc, ptr or extra-services, or a document, such as pub-199 or impb-spec."
},
"code": {
"type": "string",
"maxLength": 40,
"description": "One code of the table."
},
"from": {
"type": "string",
"description": "The older edition's date. The edition before `to` when absent."
},
"to": {
"type": "string",
"description": "The newer edition's date. The newest when absent."
},
"severity": {
"type": "string",
"enum": [
"editorial",
"additive",
"breaking"
],
"description": "Only changes rated this."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 200,
"description": "At most this many changes; 50 when absent."
}
},
"required": [
"subject"
],
"additionalProperties": false
}출력 스키마
{
"type": "object",
"properties": {
"subject": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"table",
"document"
]
}
},
"required": [
"slug",
"name",
"kind"
],
"additionalProperties": true
},
"editions": {
"type": "array",
"items": {
"type": "string"
}
},
"from": {
"type": "string"
},
"to": {
"type": "string"
},
"counts": {
"type": "object",
"properties": {
"breaking": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"additive": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"editorial": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"pending": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"breaking",
"additive",
"editorial",
"pending"
],
"additionalProperties": true
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"changes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"release": {
"type": "string"
},
"key": {
"type": "string"
},
"subject": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Code"
]
},
"table": {
"type": "string"
},
"code": {
"type": "string"
}
},
"required": [
"_tag",
"table",
"code"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Section"
]
},
"document": {
"type": "string"
},
"section": {
"type": "string"
}
},
"required": [
"_tag",
"document",
"section"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Document"
]
},
"document": {
"type": "string"
}
},
"required": [
"_tag",
"document"
],
"additionalProperties": true
}
]
},
"change": {
"type": "string",
"enum": [
"added",
"removed",
"retired",
"changed"
]
},
"row": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string"
},
"before": {
"type": "string"
},
"after": {
"type": "string"
}
},
"required": [
"column",
"before",
"after"
],
"additionalProperties": true
}
},
"removed": {
"type": "array",
"items": {
"type": "string"
}
},
"added": {
"type": "array",
"items": {
"type": "string"
}
},
"pages": {
"type": "object",
"properties": {
"before": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"after": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
}
},
"required": [
"before",
"after"
],
"additionalProperties": true
},
"rewritten": {
"type": "object",
"properties": {
"removed": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"added": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"removed",
"added"
],
"additionalProperties": true
},
"rated": {
"type": "object",
"properties": {
"severity": {
"type": "string",
"enum": [
"editorial",
"additive",
"breaking"
]
},
"rating": {
"type": "number"
},
"model": {
"type": "string"
}
},
"required": [
"severity",
"rating",
"model"
],
"additionalProperties": true
},
"severity": {
"type": "string",
"enum": [
"editorial",
"additive",
"breaking"
]
},
"ratedBy": {
"type": "string",
"enum": [
"rule",
"model",
"pending"
]
},
"revision": {
"type": "string"
}
},
"required": [
"release",
"key",
"subject",
"change",
"ratedBy"
],
"additionalProperties": true
}
}
},
"required": [
"subject",
"editions",
"to",
"counts",
"total",
"changes"
],
"additionalProperties": true
}🟢search(query, limit)
Search the codes, terms, specs and documents postalref models, exact names and codes first. A query of 20 or more digits comes back as one to decode.
입력 스키마
{
"type": "object",
"properties": {
"query": {
"type": "string",
"maxLength": 120,
"description": "A code, a term or words from a code's row: 055, mailer id, ground advantage."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "At most this many hits; 10 when absent."
}
},
"required": [
"query"
],
"additionalProperties": false
}출력 스키마
{
"type": "object",
"properties": {
"query": {
"type": "string"
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"hits": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"see": {
"type": "string"
},
"detail": {
"type": "string"
},
"entity": {
"anyOf": [
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Term"
]
},
"slug": {
"type": "string"
}
},
"required": [
"_tag",
"slug"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Document"
]
},
"slug": {
"type": "string"
}
},
"required": [
"_tag",
"slug"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Table"
]
},
"slug": {
"type": "string"
}
},
"required": [
"_tag",
"slug"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Spec"
]
},
"slug": {
"type": "string"
}
},
"required": [
"_tag",
"slug"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Field"
]
},
"spec": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"_tag",
"spec",
"key"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"_tag": {
"type": "string",
"enum": [
"Code"
]
},
"table": {
"type": "string"
},
"code": {
"type": "string"
}
},
"required": [
"_tag",
"table",
"code"
],
"additionalProperties": true
}
]
}
},
"required": [
"name",
"entity"
],
"additionalProperties": true
}
},
"decode": {
"type": "string"
}
},
"required": [
"query",
"total",
"hits"
],
"additionalProperties": true
}🟢define(name, limit)
What USPS means by a name or abbreviation: each registry entry it names, with the USPS words that define it and the page they're on, its other names, postalref's own explanation where it has one, and postalref's page about it.
입력 스키마
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"description": "A name or abbreviation USPS uses: mailer id, MID, CRID, banner text."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"description": "At most this many entries; 5 when absent."
}
},
"required": [
"name"
],
"additionalProperties": false
}출력 스키마
{
"type": "object",
"properties": {
"query": {
"type": "string"
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"entries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"aka": {
"type": "array",
"items": {
"type": "string"
}
},
"kind": {
"type": "string",
"enum": [
"product",
"term"
]
},
"cite": {
"type": "string"
},
"definition": {
"type": "object",
"properties": {
"quote": {
"type": "string"
},
"document": {
"type": "string"
},
"page": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"quote",
"document",
"url"
],
"additionalProperties": true
},
"explained": {
"type": "string"
},
"page": {
"type": "string"
}
},
"required": [
"id",
"name",
"aka",
"kind",
"cite"
],
"additionalProperties": true
}
}
},
"required": [
"query",
"total",
"entries"
],
"additionalProperties": true
}🟢read_source(document, revision, page, pages, find)
Read a revision of a modeled USPS document page by page, as extracted, to quote it: a quote cites the revision's sha256, the PDF page and the words exactly.
입력 스키마
{
"type": "object",
"properties": {
"document": {
"type": "string",
"description": "A modeled document: pub-199, impb-spec, stc-list, ptr-events, ptr2-events, stid-table, imb-spec or parcel-labeling-guide."
},
"revision": {
"type": "string",
"maxLength": 64,
"description": "A revision's sha256, or its slug, such as 2026-07-02. The newest when absent."
},
"page": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991,
"description": "The first PDF page, or sheet, to read, counting from 1. Absent with `find`: the pages that have the words."
},
"pages": {
"type": "integer",
"minimum": 1,
"maximum": 5,
"description": "How many to read, up to 5; 1 when absent."
},
"find": {
"type": "string",
"maxLength": 200,
"description": "Words to find, as one phrase, or when no page has the phrase, each word anywhere on a page. Without `page`, the text read is the first pages that have them."
}
},
"required": [
"document"
],
"additionalProperties": false
}출력 스키마
{
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"slug",
"name"
],
"additionalProperties": true
},
"revision": {
"type": "object",
"properties": {
"sha256": {
"type": "string"
},
"document": {
"type": "string"
},
"slug": {
"type": "string"
},
"fid": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"copies": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"file": {
"type": "string"
},
"original": {
"type": "string"
},
"uploaded": {
"type": "string"
},
"fetched": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"pdf",
"xlsx"
]
},
"pages": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"edition": {
"type": "string"
},
"dated": {
"type": "string"
},
"effective": {
"type": "string"
},
"supersededBy": {
"type": "string"
}
},
"required": [
"sha256",
"document",
"slug",
"fid",
"file",
"original",
"uploaded",
"fetched",
"format"
],
"additionalProperties": true
},
"revisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sha256": {
"type": "string"
},
"slug": {
"type": "string"
},
"format": {
"type": "string",
"enum": [
"pdf",
"xlsx"
]
},
"uploaded": {
"type": "string"
}
},
"required": [
"sha256",
"slug",
"format",
"uploaded"
],
"additionalProperties": true
}
},
"parts": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"text": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"page": {
"type": "object",
"properties": {
"pdf": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printed": {
"type": "string"
}
},
"required": [
"pdf"
],
"additionalProperties": true
},
"text": {
"type": "string"
}
},
"required": [
"label",
"text"
],
"additionalProperties": true
}
},
"match": {
"type": "string",
"enum": [
"phrase",
"words"
]
},
"found": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"page": {
"type": "object",
"properties": {
"pdf": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"printed": {
"type": "string"
}
},
"required": [
"pdf"
],
"additionalProperties": true
},
"context": {
"type": "string"
}
},
"required": [
"label",
"context"
],
"additionalProperties": true
}
}
},
"required": [
"document",
"revision",
"revisions",
"parts",
"text"
],
"additionalProperties": true
}🟢search_documents(query, topic, limit)
Search every document on PostalPro by title and file name, with its page and newest file. postalref models a few of them; those carry a slug for read_source.
입력 스키마
{
"type": "object",
"properties": {
"query": {
"type": "string",
"maxLength": 120,
"description": "Words from a document's title or file name."
},
"topic": {
"type": "string",
"enum": [
"mailing",
"shipping",
"address-quality",
"visibility",
"promotions",
"operations",
"accounts",
"industry",
"international",
"other"
],
"description": "Only documents a model put under this topic."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 50,
"description": "At most this many; 10 when absent."
}
},
"required": [
"query"
],
"additionalProperties": false
}출력 스키마
{
"type": "object",
"properties": {
"query": {
"type": "string"
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"documents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"nid": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"title": {
"type": "string"
},
"path": {
"type": "string"
},
"kinds": {
"type": "array",
"items": {
"type": "string"
}
},
"topic": {
"type": "string",
"enum": [
"mailing",
"shipping",
"address-quality",
"visibility",
"promotions",
"operations",
"accounts",
"industry",
"international",
"other"
]
},
"date": {
"type": "string"
},
"changed": {
"type": "string"
},
"file": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"link": {
"type": "string"
}
},
"required": [
"name",
"link"
],
"additionalProperties": true
},
"slug": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"nid",
"title",
"path",
"kinds",
"changed",
"url"
],
"additionalProperties": true
}
}
},
"required": [
"query",
"total",
"documents"
],
"additionalProperties": true
}커뮤니티
증거