@shippo/shippo-mcp 2.0.19 → 3.0.0

package/manifest.json

@@ -1,349 +0,0 @@
-{
-  "manifest_version": "0.3",
-  "name": "@shippo/shippo-mcp",
-  "version": "2.0.18",
-  "description": "",
-  "long_description": "Shippo external API.: Use this API to integrate with the Shippo service",
-  "author": {
-    "name": "shippo"
-  },
-  "server": {
-    "type": "node",
-    "entry_point": "./bin/mcp-server.js",
-    "mcp_config": {
-      "command": "node",
-      "args": [
-        "${__dirname}/bin/mcp-server.js",
-        "start",
-        "--api-key-header",
-        "${user_config.api_key_header}",
-        "--shippo-api-version",
-        "${user_config.shippo_api_version}"
-      ]
-    }
-  },
-  "display_name": "@shippo/shippo Mcp",
-  "prompts": [],
-  "keywords": [
-    "@shippo/shippo",
-    "mcp",
-    "shippo",
-    "external",
-    "api",
-    "use",
-    "this"
-  ],
-  "user_config": {
-    "api_key_header": {
-      "type": "string",
-      "title": "APIKeyHeader",
-      "description": "The APIKeyHeader to use for the request",
-      "required": true,
-      "sensitive": true
-    },
-    "shippo_api_version": {
-      "type": "string",
-      "title": "shippoApiVersion",
-      "description": "Optional string used to pick a non-default API version to use. See our <a href=\"https://docs.goshippo.com/docs/api_concepts/apiversioning/\">API version</a> guide.",
-      "required": false
-    }
-  },
-  "tools": [
-    {
-      "name": "addresses-list",
-      "description": "List all addresses\n\nReturns a list of all address objects that have been created in this account."
-    },
-    {
-      "name": "addresses-create-v1",
-      "description": "**DEPRECATED - Use `addresses-create-v2` instead for cleaner API format.**\n\nThis is the legacy v1 address creation endpoint. It uses different field names\n(street1, city, state, zip) compared to the newer v2 format.\n\n**Prefer `addresses-create-v2`** which uses standardized field names:\n- `address_line_1` instead of `street1`\n- `city_locality` instead of `city`\n- `state_province` instead of `state`\n- `postal_code` instead of `zip`\n\n**For address validation, use `addresses-validate-v2`.**\n\nOnly use this tool if you specifically need v1 API compatibility.\n"
-    },
-    {
-      "name": "addresses-get",
-      "description": "Retrieve an address\n\nReturns an existing address using an object ID."
-    },
-    {
-      "name": "addresses-validate-existing",
-      "description": "**DEPRECATED - Use `addresses-validate-v2` instead for better validation results.**\n\nThis v1 endpoint validates an already created address using its ID.\nIt only works on addresses that have been saved to Shippo's address book.\n\n**Prefer `addresses-validate-v2`** which:\n- Validates any address (no need to create first)\n- Returns confidence scores (high/medium/low)\n- Provides recommended address corrections\n- Returns geo coordinates (latitude/longitude)\n- Identifies residential vs commercial addresses\n\nOnly use this tool if you specifically need to re-validate an existing address record by ID.\n"
-    },
-    {
-      "name": "addresses-parse",
-      "description": "**ADDRESS PARSER** - Converts an unstructured address string into a structured address object.\n\nUse this tool when you have a single address string (like from customer input, emails, \nor CSV imports) and need to parse it into structured components.\n\n**Input Format Tips:**\n- Use commas (,) as delimiters between address parts\n- Follow this order: street address, city, state, postal code, country\n- Phone and email can be anywhere in the string\n\n**Example Input:**\n\"Shippo 731 Market St #200, San Francisco, CA 94103 US shippo@shippo.com +1-555-999-8888\"\n\n**Example Output:**\n```json\n{\n  \"address_line_1\": \"731 MARKET ST\",\n  \"address_line_2\": \"#200\",\n  \"city_locality\": \"SAN FRANCISCO\",\n  \"state_province\": \"CA\",\n  \"postal_code\": \"94103\",\n  \"country_code\": \"US\",\n  \"email\": \"shippo@shippo.com\",\n  \"phone\": \"+1-555-999-8888\"\n}\n```\n\n**Use Cases:**\n- Parse addresses from customer contact forms\n- Extract structured data from email signatures\n- Process bulk address imports\n- Clean up poorly formatted address data\n"
-    },
-    {
-      "name": "addresses-validate-v2",
-      "description": "**PRIMARY ADDRESS VALIDATION TOOL** - Use this tool whenever asked to validate an address.\n\nThis is the recommended v2 validation endpoint that provides comprehensive results:\n- Original address as submitted\n- Recommended address with corrections\n- Confidence score (high/medium/low)\n- Validation result (valid/invalid/unknown)\n- Address type (residential/commercial/unknown)\n- List of changed attributes\n- Geographic coordinates (latitude/longitude)\n\n**Required Fields:**\n- `address_line_1`: The street address (required)\n- `country_code`: ISO 3166 country code (required)\n\n**US Address Requirements (one of):**\n- state_province + city_locality + address_line_1\n- OR address_line_1 + postal_code\n\n**International Requirements:**\n- city_locality + address_line_1\n\n**Example Request:**\n```\naddress_line_1: \"731 Market Street\"\naddress_line_2: \"#200\"\ncity_locality: \"San Francisco\"\nstate_province: \"CA\"\npostal_code: \"94103\"\ncountry_code: \"US\"\n```\n\n**Example Response:**\n```json\n{\n  \"recommended_address\": {\n    \"address_line_1\": \"731 MARKET ST\",\n    \"city_locality\": \"SAN FRANCISCO\",\n    \"state_province\": \"CA\",\n    \"postal_code\": \"94103-2007\",\n    \"country_code\": \"US\",\n    \"confidence_result\": {\n      \"score\": \"high\",\n      \"description\": \"Address verified\"\n    }\n  },\n  \"analysis\": {\n    \"validation_result\": {\"value\": \"valid\"},\n    \"address_type\": \"commercial\",\n    \"changed_attributes\": [\"address_line_1\", \"postal_code\"]\n  },\n  \"geo\": {\"latitude\": 37.7879, \"longitude\": -122.4074}\n}\n```\n\n**Use Cases:**\n- Validate customer shipping addresses before label purchase\n- Get corrected/standardized address formatting\n- Determine if address is residential or commercial\n- Get ZIP+4 extended postal codes\n- Geocode addresses for mapping\n"
-    },
-    {
-      "name": "addresses-create-v2",
-      "description": "**PRIMARY ADDRESS CREATION TOOL** - Use this tool to create and save address records.\n\nThis is the recommended v2 endpoint for creating addresses with a cleaner, standardized format.\n\n**Required Fields:**\n- `name`: The addressee's name (max 64 chars)\n- `address_line_1`: Street address (1-100 chars)\n- `country_code`: ISO 3166 country code (2 chars, e.g., \"US\")\n\n**Optional Fields:**\n- `organization`: Company/organization name\n- `email`: Email address\n- `phone`: Phone number\n- `address_line_2`: Apt, suite, unit, etc.\n- `city_locality`: City name\n- `state_province`: State/province abbreviation\n- `postal_code`: ZIP/postal code\n- `address_type`: unknown, residential, commercial, po_box, military\n\n**Example Request:**\n```json\n{\n  \"name\": \"Wilson\",\n  \"organization\": \"Shippo\",\n  \"email\": \"user@shippo.com\",\n  \"phone\": \"+1-4155550132\",\n  \"address_line_1\": \"731 Market Street\",\n  \"address_line_2\": \"#200\",\n  \"city_locality\": \"San Francisco\",\n  \"state_province\": \"CA\",\n  \"postal_code\": \"94103\",\n  \"country_code\": \"US\",\n  \"address_type\": \"commercial\"\n}\n```\n\n**Response includes:**\n- `id`: Unique address identifier for future reference\n- `address`: The saved address data\n- `created_at`/`updated_at`: Timestamps\n\n**Use Cases:**\n- Save addresses for reuse in shipments\n- Build an address book\n- Store customer shipping addresses\n\n**For address validation, use `addresses-validate-v2`** which provides\nconfidence scores, geo coordinates, and recommended corrections.\n"
-    },
-    {
-      "name": "batches-create",
-      "description": "Create a batch\n\nCreates a new batch object for purchasing shipping labels for many shipments at once. Batches are created asynchronously. This means that the API response won't include your batch shipments yet. You need to retrieve the batch later to verify that all batch shipments are valid.\n\n**IMPORTANT: There is NO batches-list endpoint in the Shippo API.**\nYou must store the batch `object_id` returned from this endpoint to retrieve batches later using `batches-get`.\n\n**Workflow:**\n1. Create batch → Save the returned `object_id`\n2. Retrieve batch status using `batches-get` with the saved ID\n3. Add/remove shipments as needed\n4. Purchase the batch when ready\n"
-    },
-    {
-      "name": "batches-get",
-      "description": "Retrieve a batch\n\nReturns a batch using an object ID. Batch shipments are displayed 100 at a time. You can iterate through each `page` using the `?page=` query parameter. You can also filter based on batch shipment status, for example, by passing a query param like `?object_results=creation_failed`.\n\n**IMPORTANT: There is NO batches-list endpoint in the Shippo API.**\nYou must know the batch `object_id` (returned when you created the batch) to retrieve it.\nStore batch IDs when creating batches if you need to access them later.\n\n**URL HANDLING:** This response contains `label_url` (array of download URLs).\nWhen displaying URLs, ALWAYS show the complete URL without truncation.\nNever replace parts with \"...\" - S3 signed URLs will break if truncated.\n"
-    },
-    {
-      "name": "batches-add-shipments",
-      "description": "Add shipments to a batch\n\nAdds batch shipments to an existing batch."
-    },
-    {
-      "name": "batches-purchase",
-      "description": "Purchase a batch\n\nPurchases an existing batch with a status of `VALID`. \nOnce you send a POST request to the purchase endpoint the batch status will change to `PURCHASING`. \nWhen all the shipments are purchased, the status will change to `PURCHASED` and you will receive a \n`batch_purchased` webhook indicating that the batch has been purchased"
-    },
-    {
-      "name": "batches-remove-shipments",
-      "description": "Remove shipments from a batch\n\nRemoves shipments from an existing batch shipment."
-    },
-    {
-      "name": "carrier-accounts-list",
-      "description": "List all carrier accounts\n\nReturns a list of all carrier accounts connected to your Shippo account. These carrier accounts include both Shippo carrier accounts and your own carrier accounts that you have connected to your Shippo account.\n\nAdditionally, you can get information about the service levels associated with each carrier account by passing in the `?service_levels=true` query parameter. <br>\nUsing it appends the property `service_levels` to each carrier account. <br>\nBy default, if the query parameter is omitted, the `service_levels` property will not be included in the response."
-    },
-    {
-      "name": "carrier-accounts-create",
-      "description": "Create a new carrier account\n\nCreates a new carrier account or connects an existing carrier account to the Shippo account."
-    },
-    {
-      "name": "carrier-accounts-get",
-      "description": "Retrieve a carrier account\n\nReturns an existing carrier account using an object ID."
-    },
-    {
-      "name": "carrier-accounts-initiate-oauth2-signin",
-      "description": "Connect an existing carrier account using OAuth 2.0\n\nUsed by client applications to setup or reconnect an existing carrier account with carriers that support OAuth 2.0"
-    },
-    {
-      "name": "carrier-accounts-register",
-      "description": "Add a Shippo carrier account\n\nAdds a Shippo carrier account"
-    },
-    {
-      "name": "carrier-accounts-get-registration-status",
-      "description": "Get Carrier Registration status\n\nReturns the registration status for the given account for the given carrier"
-    },
-    {
-      "name": "carrier-accounts-update",
-      "description": "Update a carrier account\n\nUpdates an existing carrier account object. The account_id and carrier can't be updated. This is because they form the unique identifier together."
-    },
-    {
-      "name": "customs-declarations-list",
-      "description": "List all customs declarations\n\nReturns a a list of all customs declaration objects"
-    },
-    {
-      "name": "customs-declarations-create",
-      "description": "**INTERNATIONAL SHIPPING CUSTOMS DECLARATION** - Use this tool when creating international shipments that require customs documentation.\n\nThis tool creates customs declarations for international shipments. Required for all non-domestic shipments.\n\n**Required Fields:**\n- `certify`: Must be true\n- `certify_signer`: Name of person certifying the information\n- `contents_type`: Type of goods (GIFT, MERCHANDISE, DOCUMENTS, SAMPLE, etc.)\n- `items`: Array of item details with descriptions, weights, values, and HS codes\n- `non_delivery_option`: What to do if undeliverable (ABANDON or RETURN)\n\n**Example Usage:**\n```json\n{\n  \"certify\": true,\n  \"certify_signer\": \"John Sender\",\n  \"contents_type\": \"GIFT\",\n  \"items\": [{\n    \"description\": \"Electronics accessory\",\n    \"mass_unit\": \"lb\",\n    \"net_weight\": \"1\",\n    \"origin_country\": \"US\",\n    \"quantity\": 1,\n    \"value_amount\": \"45.00\",\n    \"value_currency\": \"USD\",\n    \"hs_code\": \"8518.30.20\"\n  }],\n  \"non_delivery_option\": \"RETURN\"\n}\n```\n\n**Optional Fields:**\n- `address_importer`: Importer address (can be null)\n- `duties_payor`: Who pays duties (can be null)\n- `exporter_identification`: Exporter tax info (can be null)\n- `invoice`: Invoice number\n- `notes`: Additional notes\n\n**IMPORTANT FIELD HANDLING:**\n- **OMIT optional complex fields if not needed** (don't include with null values)\n- **For GIFT shipments**: Usually only need required fields\n- **For MERCHANDISE**: May need additional exporter info\n\n**Common Mistakes to Avoid:**\n- ❌ Don't include `exporter_identification: null` - omit entirely if not needed\n- ❌ Don't include complex nested objects with null values\n- ✅ Keep it simple for gifts and samples\n\n**Simplified GIFT Example:**\n```json\n{\n  \"certify\": true,\n  \"certify_signer\": \"Sender Name\",\n  \"contents_type\": \"GIFT\", \n  \"items\": [{\"description\": \"Item\", \"mass_unit\": \"lb\", \"net_weight\": \"1\", \"origin_country\": \"US\", \"quantity\": 1, \"value_amount\": \"25.00\", \"value_currency\": \"USD\"}],\n  \"non_delivery_option\": \"RETURN\"\n}\n```\n\n**Important:** Many fields are nullable to handle different international shipping scenarios, but it's safer to omit optional fields entirely rather than setting them to null.\n"
-    },
-    {
-      "name": "customs-declarations-get",
-      "description": "Retrieve a customs declaration\n\nReturns an existing customs declaration using an object ID"
-    },
-    {
-      "name": "customs-items-list",
-      "description": "List all customs items\n\nReturns a list all customs items objects."
-    },
-    {
-      "name": "customs-items-create",
-      "description": "Create a new customs item\n\nCreates a new customs item object."
-    },
-    {
-      "name": "customs-items-get",
-      "description": "Retrieve a customs item\n\nReturns an existing customs item using an object ID"
-    },
-    {
-      "name": "rates-at-checkout-create",
-      "description": "Generate a live rates request\n\nInitiates a live rates request. Include either the object ID for\nan existing address record or a fully formed address object when entering\nan address value. You can also enter the object ID of an existing user parcel\ntemplate or a fully formed user parcel template object as the parcel value."
-    },
-    {
-      "name": "rates-at-checkout-get-default-parcel-template",
-      "description": "Show current default parcel template\n\nRetrieve and display the currently configured default parcel template for live rates."
-    },
-    {
-      "name": "rates-at-checkout-delete-default-parcel-template",
-      "description": "Clear current default parcel template\n\nClears the currently configured default parcel template for live rates."
-    },
-    {
-      "name": "rates-checkout-update-parcel-template",
-      "description": "Update default parcel template\n\nUpdate the currently configured default parcel template for live rates. The object_id in the request payload should identify the user parcel template to be the new default."
-    },
-    {
-      "name": "manifests-list",
-      "description": "Returns a list of all manifest objects.\n\n**⚠️ URL HANDLING - CRITICAL:**\nEach manifest contains a `documents` field with URLs to scan form PDFs.\nWhen displaying these URLs:\n- ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with \"...\"\n- These are S3 signed URLs that break if modified\n- Display URLs in a code block AND as a clickable hyperlink\n"
-    },
-    {
-      "name": "manifests-create",
-      "description": "Create a new manifest\n\nCreates a new manifest object."
-    },
-    {
-      "name": "manifests-get",
-      "description": "Returns an existing manifest using an object ID.\n\n**⚠️ URL HANDLING - CRITICAL:**\nThe manifest contains a `documents` field with URLs to scan form PDFs.\nWhen displaying these URLs:\n- ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with \"...\"\n- These are S3 signed URLs that break if modified\n- Display URLs in a code block AND as a clickable hyperlink\n"
-    },
-    {
-      "name": "orders-list",
-      "description": "List all orders\n\nReturns a list of all order objects.\n\n**Available Filters:**\n- `orderStatus`: Filter by order status. Can pass multiple values as an array.\n  - Values: UNKNOWN, AWAITPAY, PAID, REFUNDED, CANCELLED, PARTIALLY_FULFILLED, SHIPPED\n- `shop_app`: Filter by platform/source where order was created\n  - Values: Amazon, Bigcommerce, CSV_Import, eBay, ePages, Etsy, Godaddy, Magento, Shippo, Shopify, Spreecommerce, StripeRelay, Walmart, Weebly, WooCommerce\n- `start_date`: Filter orders placed AFTER this date/time (ISO 8601 UTC format, e.g., \"2025-01-01T00:00:00Z\")\n- `end_date`: Filter orders placed BEFORE this date/time (ISO 8601 UTC format)\n- `page/results`: Pagination controls\n\n**Example Use Cases:**\n- \"Show all paid orders\" → filter by `orderStatus: [\"PAID\"]`\n- \"Show Shopify orders from last week\" → combine `shop_app: \"Shopify\"` with date filters\n- \"Show orders ready to ship\" → filter by `orderStatus: [\"PAID\"]`\n- \"Show cancelled or refunded orders\" → filter by `orderStatus: [\"CANCELLED\", \"REFUNDED\"]`\n\n**Note:** Date filters are based on `placed_at` field (when order was placed), not when the order object was created in Shippo.\n"
-    },
-    {
-      "name": "orders-create",
-      "description": "Create a new order\n\nCreates a new order object."
-    },
-    {
-      "name": "orders-get",
-      "description": "Retrieve an order\n\nRetrieves an existing order using an object ID."
-    },
-    {
-      "name": "orders-get-packing-slip",
-      "description": "**GENERATE PACKING SLIP** - Creates a downloadable packing slip PDF for an order.\n\nUse this tool when a customer needs a packing slip document for order fulfillment.\n\n**Required Parameter:**\n- `OrderId`: The order object ID (from orders-list or orders-create)\n\n**Response:**\n```json\n{\n  \"slip_url\": \"https://shippo-delivery-east.s3.amazonaws.com/packingslip_{hash}.pdf?{signed_params}\",\n  \"created\": \"2026-01-07T16:58:46.350467\",\n  \"expires\": \"2026-01-08T16:58:46.350468\"\n}\n```\n\n**Key Fields:**\n- `slip_url`: Signed S3 URL to download the packing slip PDF (valid for 24 hours)\n- `created`: When the packing slip was generated\n- `expires`: When the download URL expires\n\n**⚠️ URL HANDLING - CRITICAL:**\nThe `slip_url` is a signed S3 URL that contains required authentication parameters.\nWhen displaying this URL:\n- ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with \"...\"\n- S3 signed URLs will NOT work if modified or truncated\n- Display the URL in a code block AND as a clickable hyperlink\n\n**Example Usage:**\n1. List orders: `orders-list` → Get an order ID\n2. Generate packing slip: `orders-get-packing-slip` with OrderId\n3. Download PDF from the returned `slip_url`\n"
-    },
-    {
-      "name": "carrier-parcel-templates-list",
-      "description": "List all carrier parcel templates\n\nList all carrier parcel template objects. <br> Use the following query string params to filter the results as needed. <br>\n<ul>\n<li>`include=all` (the default). Includes templates from all carriers </li>\n<li>`include=user`. Includes templates only from carriers which the user has added (whether or not they're currently enabled) </li>\n<li>`include=enabled`. includes templates only for carriers which the user has added and enabled </li>\n<li>`carrier=*token*`. filter by specific carrier, e.g. fedex, usps </li>\n</ul>"
-    },
-    {
-      "name": "carrier-parcel-templates-get",
-      "description": "Retrieve a carrier parcel templates\n\nFetches the parcel template information for a specific carrier parcel template, identified by the token."
-    },
-    {
-      "name": "parcels-list",
-      "description": "List all parcels\n\nReturns a list of all parcel objects."
-    },
-    {
-      "name": "parcels-create",
-      "description": "Create a new parcel\n\nCreates a new parcel object."
-    },
-    {
-      "name": "parcels-get",
-      "description": "Retrieve an existing parcel\n\nReturns parcel details using an existing parcel object ID (this will not return parcel details associated with un-purchased shipment/rate parcel object IDs)."
-    },
-    {
-      "name": "pickups-create",
-      "description": "Create a pickup\n\nCreates a pickup object. This request is for a carrier to come to a specified location to take a package for shipping."
-    },
-    {
-      "name": "rates-get",
-      "description": "Retrieve a rate\n\nReturns an existing rate using a rate object ID."
-    },
-    {
-      "name": "rates-list-by-currency-code",
-      "description": "Retrieve shipment rates in currency\n\nReturns all available shipping rates for a shipment object.\n\nWhen you create a new valid shipment object, Shippo automatically calculates all available rates. Depending on your shipment data, there may be none, one or multiple rates.\n\nBy default, the calculated rates will return the price in two currencies under the `amount` and `amount_local` keys, respectively. The `amount` key will contain the price of a rate expressed in the currency that is used in the country from where the parcel originates, and the `amount_local` key will contain the price expressed in the currency that is used in the country the parcel is shipped to. You can request rates with prices expressed in a different currency by adding the currency code to the end of the resource URL. The full list of supported currencies along with their codes can be viewed on <a href=\"http://openexchangerates.org/api/currencies.json\">open exchange rates</a>.\n\nNote: re-requesting the rates with a different currency code will re-queue the shipment (i.e. set the Shipment's `status` to `QUEUED`) and the converted currency rates will only be available when the Shipment's `status` is set to `SUCCESS`."
-    },
-    {
-      "name": "refunds-create",
-      "description": "Create a refund\n\nCreates a new refund object."
-    },
-    {
-      "name": "refunds-list",
-      "description": "List all refunds\n\nReturns a list all refund objects."
-    },
-    {
-      "name": "refunds-get",
-      "description": "Retrieve a refund\n\nReturns an existing rate using a rate object ID."
-    },
-    {
-      "name": "service-groups-list",
-      "description": "List all service groups\n\nReturns a list of service group objects."
-    },
-    {
-      "name": "service-groups-create",
-      "description": "Create a new service group\n\nCreates a new service group."
-    },
-    {
-      "name": "service-groups-update",
-      "description": "Update an existing service group\n\nUpdates an existing service group object. <br>The object_id cannot be updated as it is the unique identifier for the object."
-    },
-    {
-      "name": "service-groups-delete",
-      "description": "Delete a service group\n\nDeletes an existing service group using an object ID."
-    },
-    {
-      "name": "shipments-list",
-      "description": "**LIST SHIPMENTS (Rate Quotes)** - NOT for finding delivered packages!\n\nThis tool lists shipment objects, which represent rate shopping sessions. Each shipment contains:\n- Sender/recipient addresses\n- Parcel dimensions\n- Available shipping rates from carriers\n\n**IMPORTANT DISTINCTIONS:**\n- Shipments = Rate quotes/shopping sessions\n- Shipments do NOT have tracking or delivery status\n- Use `transactions-list` to find purchased labels with tracking status\n\n**When to use this tool:**\n- List recent rate shopping sessions\n- Find a shipment to view its rates\n- Review shipment details before purchasing a label\n\n**When NOT to use this tool:**\n- ❌ Finding \"delivered\" shipments (use transactions-list instead)\n- ❌ Getting tracking information (use tracking-status-get)\n- ❌ Finding purchased labels (use transactions-list)\n\n**Available Filters:**\n- `object_created_gt/gte/lt/lte`: Filter by creation date\n- `page/results`: Pagination\n\n**Example Use Case:**\n\"Show me shipments I created this week\" → Use this tool\n\"Show me delivered packages\" → Use transactions-list with tracking_status filter\n"
-    },
-    {
-      "name": "shipments-create",
-      "description": "Creates a new shipment object with proper parcel dimensions and addresses.\n\nComplete example request:\n```json\n{\n  \"address_from\": {\n    \"name\": \"John Sender\",\n    \"street1\": \"123 Market St\",\n    \"city\": \"San Francisco\",\n    \"state\": \"CA\",\n    \"zip\": \"94102\",\n    \"country\": \"US\"\n  },\n  \"address_to\": {\n    \"name\": \"Jane Recipient\", \n    \"street1\": \"456 Broadway\",\n    \"city\": \"New York\",\n    \"state\": \"NY\",\n    \"zip\": \"10001\",\n    \"country\": \"US\"\n  },\n  \"parcels\": [{\n    \"length\": \"12\",\n    \"width\": \"9\",\n    \"height\": \"3\",\n    \"distance_unit\": \"in\",\n    \"weight\": \"1\",\n    \"mass_unit\": \"lb\"\n  }]\n}\n```\n\n**International Shipment Example (REQUIRED FORMAT):**\n```json\n{\n  \"address_from\": {\n    \"name\": \"St Pete Sender\",\n    \"street1\": \"123 Central Ave\",\n    \"city\": \"St. Petersburg\",\n    \"state\": \"FL\",\n    \"zip\": \"33701\",\n    \"country\": \"US\",\n    \"email\": \"sender@example.com\",\n    \"phone\": \"7275550123\"\n  },\n  \"address_to\": {\n    \"name\": \"Munich Recipient\",\n    \"street1\": \"Marienplatz 1\",\n    \"city\": \"Munich\",\n    \"state\": \"Bavaria\",\n    \"zip\": \"80331\",\n    \"country\": \"DE\"\n  },\n  \"parcels\": [{\n    \"length\": \"4\",\n    \"width\": \"4\",\n    \"height\": \"4\",\n    \"distance_unit\": \"in\",\n    \"weight\": \"1\",\n    \"mass_unit\": \"lb\"\n  }]\n}\n```\n\nRequired parcel fields:\n- length, width, height (dimensions as strings)\n- distance_unit (\"in\", \"cm\", \"ft\", \"m\", \"mm\", \"yd\")\n- weight (as string)\n- mass_unit (\"lb\", \"kg\", \"g\", \"oz\")\n\nRequired address fields:\n- name, street1, city, state, zip, country\n\n**INTERNATIONAL SHIPPING REQUIREMENTS:**\n- email and phone REQUIRED for sender address\n- customs_declaration can be omitted initially to get rates\n- For label creation, customs declaration is mandatory\n- DHL Express requires phone number for recipient address\n"
-    },
-    {
-      "name": "shipments-get",
-      "description": "Retrieve a shipment\n\nReturns an existing shipment using an object ID"
-    },
-    {
-      "name": "shipments-list-rates",
-      "description": "Retrieve shipment rates\n\nReturns a paginated list of rates associated with a shipment"
-    },
-    {
-      "name": "tracking-status-create",
-      "description": "Register a tracking webhook for shipment status updates.\n\n**IMPORTANT TEST MODE BEHAVIOR:**\nWhen using test tokens, you MUST use 'shippo' as the carrier parameter, \nnot the actual carrier names like 'USPS', 'UPS', 'FedEx', etc.\n\n**Test Mode Usage:**\n```json\n{\n  \"carrier\": \"shippo\",\n  \"tracking_number\": \"your_tracking_number\",\n  \"metadata\": \"optional_metadata\"\n}\n```\n\n**Production Mode Usage:**\n```json\n{\n  \"carrier\": \"USPS\",  // or \"UPS\", \"FedEx\", etc.\n  \"tracking_number\": \"your_tracking_number\",\n  \"metadata\": \"optional_metadata\"\n}\n```\n\nThe API will return an error if you use real carrier names with test tokens.\n"
-    },
-    {
-      "name": "tracking-status-get",
-      "description": "Get tracking status for a shipment using carrier and tracking number.\n\n**IMPORTANT TEST MODE BEHAVIOR:**\nWhen using test tokens, you MUST use 'shippo' as the Carrier parameter, \nnot the actual carrier names like 'USPS', 'UPS', 'FedEx', etc.\n\n**Test Mode Usage:**\n```json\n{\n  \"Carrier\": \"shippo\",\n  \"TrackingNumber\": \"your_tracking_number\"\n}\n```\n\n**Production Mode Usage:**\n```json\n{\n  \"Carrier\": \"USPS\",  // or \"UPS\", \"FedEx\", etc.\n  \"TrackingNumber\": \"your_tracking_number\"\n}\n```\n\nThe API will return an error if you use real carrier names with test tokens.\n\n**⚠️ URL HANDLING - CRITICAL:**\nThe response may include tracking URLs. When displaying any URLs:\n- ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with \"...\"\n- Display URLs in a code block AND as a clickable hyperlink\n"
-    },
-    {
-      "name": "transactions-list",
-      "description": "**LIST TRANSACTIONS (Purchased Labels)** - Use this for finding shipped/delivered packages!\n\nThis tool lists transaction objects, which represent purchased shipping labels. Each transaction contains:\n- Tracking number and tracking URL\n- Label URL for printing\n- Tracking status (UNKNOWN, PRE_TRANSIT, TRANSIT, DELIVERED, RETURNED, FAILURE)\n- Purchase date and carrier info\n\n**IMPORTANT DISTINCTIONS:**\n- Transactions = Purchased shipping labels\n- Transactions HAVE tracking status and tracking numbers\n- Use `shipments-list` for rate quotes (unpurchased shipments)\n\n**When to use this tool:**\n- Find delivered packages → filter by `tracking_status: \"DELIVERED\"`\n- Find packages in transit → filter by `tracking_status: \"TRANSIT\"`\n- List all purchased labels\n- Find a specific label by rate ID\n\n**Available Filters:**\n- `tracking_status`: UNKNOWN, PRE_TRANSIT, TRANSIT, DELIVERED, RETURNED, FAILURE\n- `object_status`: WAITING, QUEUED, SUCCESS, ERROR, REFUNDED, REFUNDPENDING, REFUNDREJECTED\n- `rate`: Filter by rate ID\n- `page/results`: Pagination\n\n**Example Use Cases:**\n- \"Show delivered shipments\" → `{tracking_status: \"DELIVERED\"}`\n- \"Show packages in transit\" → `{tracking_status: \"TRANSIT\"}`\n- \"Show all labels\" → `{results: 25}`\n\n**Note on Test Mode:**\nTest transactions will always show `tracking_status: \"UNKNOWN\"` because they don't receive real carrier tracking updates.\n\n**⚠️ URL HANDLING - CRITICAL:**\nEach transaction may include URLs (label_url, qr_code_url, tracking_url_provider).\nWhen displaying these URLs:\n- ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with \"...\"\n- These are S3 signed URLs that break if modified\n- Display URLs in a code block AND as a clickable hyperlink\n"
-    },
-    {
-      "name": "transactions-create",
-      "description": "Creates a shipping label by purchasing an existing rate.\n\n**IMPORTANT:** The request parameter must be a JSON object, not a string.\n\n**Usage:**\nThis tool creates shipping labels by purchasing existing rates from shipments.\nFirst create a shipment to get rates, then use this tool with the rate ID.\n\n**Required Format:**\n```json\n{\n  \"rate\": \"rate_id_here\"\n}\n```\n\n**Working Example:**\n```json\n{\n  \"rate\": \"b3b719ce08754a249a1fc20db7a61f4b\",\n  \"async\": false\n}\n```\n\n**INTERNATIONAL SHIPMENTS - CRITICAL NOTES:**\n- **ALWAYS use `async: true` for international shipments** to avoid timeouts\n- **Server load can cause 500/504 errors** - retry with async processing\n- **Customs declaration must be attached to shipment** before label creation\n\n**International Example:**\n```json\n{\n  \"rate\": \"international_rate_id\",\n  \"async\": true\n}\n```\n\n**Error Handling:**\n- If you get 504 Gateway timeout → Use `async: true`\n- If you get 500 Internal Server Error → Retry with `async: true`\n- If customs error → Ensure shipment has valid customs_declaration\n\n**Optional Parameters:**\n- `async`: **Set to true for international** (default: false)\n- `label_file_type`: PDF_4x6, PNG, etc.\n- `metadata`: Custom metadata string\n- `order`: Order ID reference\n\n**Workflow:**\n1. Create shipment → Get rates\n2. **For international: Attach customs declaration**\n3. Choose rate → Use this tool with rate ID\n4. **For international: Use async=true**\n5. **If async: Poll transaction status until complete**\n\n**Async Processing Pattern:**\n```javascript\n// 1. Create async transaction\n{\"rate\": \"rate_id\", \"async\": true}\n\n// 2. Get transaction ID from response\n// Response: {\"object_id\": \"txn_123\", \"status\": \"QUEUED\"}\n\n// 3. Poll using transactions-get until done\n// Use: mcp_shippo-node_transactions-get with TransactionId\n// Keep checking until status changes from \"QUEUED\" to \"SUCCESS\"\n\n// 4. Once SUCCESS: label_url, tracking_number will be populated\n```\n\n**Status Flow:**\n- `QUEUED` → Processing (keep polling)\n- `SUCCESS` → ✅ Label ready! Check label_url and tracking_number\n- `ERROR` → ❌ Check messages for details\n\n**⚠️ URL HANDLING - CRITICAL:**\nWhen transaction succeeds, the response includes:\n- `label_url`: S3 signed URL for shipping label download\n- `qr_code_url`: QR code image URL (if requested)\n- `tracking_url_provider`: Carrier's tracking page URL\n\n**When displaying these URLs:**\n- ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with \"...\"\n- S3 signed URLs contain required query parameters (Signature, Expires, AWSAccessKeyId)\n- Truncating these URLs will make them non-functional\n- Display URLs in a code block AND as a clickable hyperlink\n"
-    },
-    {
-      "name": "transactions-get",
-      "description": "Retrieve a shipping label transaction by its ID.\n\n**PRIMARY USE: Polling async transaction status**\n\n**Async Transaction Polling Pattern:**\n```javascript\n// After creating async transaction, poll until complete:\n\n// 1. Create async transaction → Get transaction_id\n// 2. Poll this endpoint until status != \"QUEUED\"\n\n// Poll example:\n{TransactionId: \"5bd872675aee4e7fb19f961d319fac44\"}\n```\n\n**Transaction Status Values:**\n- `QUEUED` → Still processing (keep polling)\n- `SUCCESS` → ✅ Label ready! Check response for:\n  - `label_url`: Download link for shipping label\n  - `tracking_number`: Package tracking number  \n  - `tracking_url_provider`: Carrier tracking URL\n- `ERROR` → ❌ Failed (check `messages` field for details)\n\n**Polling Best Practice:**\n- Poll every 2-3 seconds until status changes\n- International shipments typically take 10-30 seconds\n- Domestic shipments typically take 2-5 seconds\n\n**Required Parameter:**\n- `TransactionId`: The transaction object ID from transaction creation\n\n**⚠️ URL HANDLING - CRITICAL:**\nWhen displaying URLs from this response (label_url, qr_code_url, tracking_url_provider):\n- ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with \"...\"\n- These are S3 signed URLs with required query parameters (Signature, Expires, AWSAccessKeyId)\n- Truncating these URLs will make them non-functional\n- Display URLs in a code block AND as a clickable hyperlink\n"
-    },
-    {
-      "name": "user-parcel-templates-list",
-      "description": "List all user parcel templates\n\nReturns a list all of all user parcel template objects."
-    },
-    {
-      "name": "user-parcel-templates-create",
-      "description": "Create a new user parcel template\n\nCreates a new user parcel template. <br>You can choose to create a\nparcel template using a preset carrier template as a starting point, or\nyou can create an entirely custom one. To use a preset carrier template,\npass in a unique template token from <a href=\"#tag/Parcel-Templates\">this list</a>\nplus the weight fields (**weight** and **weight_unit**). Otherwise, omit\nthe template field and pass the other fields, for the weight, length, height,\nand depth, as well as their units.\""
-    },
-    {
-      "name": "user-parcel-templates-delete",
-      "description": "Delete a user parcel template\n\nDeletes a user parcel template using an object ID."
-    },
-    {
-      "name": "user-parcel-templates-get",
-      "description": "Retrieves a user parcel template\n\nReturns the parcel template information for a specific user parcel\ntemplate, identified by the object ID."
-    },
-    {
-      "name": "user-parcel-templates-update",
-      "description": "Update an existing user parcel template\n\nUpdates an existing user parcel template."
-    },
-    {
-      "name": "shippo-accounts-list",
-      "description": "List all Shippo Accounts\n\nReturns a list of Shippo Managed Accounts objects."
-    },
-    {
-      "name": "shippo-accounts-create",
-      "description": "Create a Shippo Account\n\nCreates a new <a href=\"https://docs.goshippo.com/docs/platformaccounts/platform_using_accounts/\">Shippo Managed Account</a>."
-    },
-    {
-      "name": "shippo-accounts-get",
-      "description": "Retrieve a Shippo Account\n\nReturns a Shippo Managed Account using an object ID."
-    },
-    {
-      "name": "shippo-accounts-update",
-      "description": "Update a Shippo Account\n\nUpdates a Shippo Managed Account using an object ID."
-    },
-    {
-      "name": "webhooks-create",
-      "description": "Create a new webhook\n\nCreates a new webhook to send notifications to a URL when a specific event occurs."
-    },
-    {
-      "name": "webhooks-list",
-      "description": "List all webhooks\n\nReturns a list of all webhooks you have created."
-    },
-    {
-      "name": "webhooks-get",
-      "description": "Retrieve a specific webhook\n\nReturns the details of a specific webhook using the webhook object ID."
-    },
-    {
-      "name": "webhooks-update",
-      "description": "Update an existing webhook\n\nUpdates an existing webhook using the webhook object ID."
-    },
-    {
-      "name": "webhooks-delete",
-      "description": "Delete a specific webhook\n\nDeletes a specific webhook using the webhook object ID."
-    }
-  ]
-}

package/src/core.ts

@@ -1,13 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { ClientSDK } from "./lib/sdks.js";
-
-/**
- * A minimal client to use when calling standalone SDK functions. Typically, an
- * instance of this class would be instantiated once at the start of an
- * application and passed around through some dependency injection mechanism  to
- * parts of an application that need to make SDK calls.
- */
-export class ShippoSDKCore extends ClientSDK {}

package/src/funcs/addressesCreateV1.ts

@@ -1,169 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { ShippoSDKCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import * as M from "../lib/matchers.js";
-import { compactMap } from "../lib/primitives.js";
-import { safeParse } from "../lib/schemas.js";
-import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
-import { pathToFunc } from "../lib/url.js";
-import {
-  AddressCreateRequest,
-  AddressCreateRequest$zodSchema,
-} from "../models/addresscreaterequest.js";
-import {
-  CreateAddressResponse,
-  CreateAddressResponse$zodSchema,
-} from "../models/createaddressop.js";
-import { APIError } from "../models/errors/apierror.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import { APICall, APIPromise } from "../types/async.js";
-import { Result } from "../types/fp.js";
-
-/**
- * Create a new address
- *
- * @remarks
- * Creates a new address object. You can use address objects to create new shipments, calculate rates, and to create orders.
- */
-export function addressesCreateV1(
-  client$: ShippoSDKCore,
-  request: AddressCreateRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    CreateAddressResponse,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >
-> {
-  return new APIPromise($do(
-    client$,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client$: ShippoSDKCore,
-  request: AddressCreateRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      CreateAddressResponse,
-      | APIError
-      | SDKValidationError
-      | UnexpectedClientError
-      | InvalidRequestError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | ConnectionError
-    >,
-    APICall,
-  ]
-> {
-  const parsed$ = safeParse(
-    request,
-    (value$) => AddressCreateRequest$zodSchema.parse(value$),
-    "Input validation failed",
-  );
-  if (!parsed$.ok) {
-    return [parsed$, { status: "invalid" }];
-  }
-  const payload$ = parsed$.value;
-  const body$ = encodeJSON("body", payload$, { explode: true });
-  const path$ = pathToFunc("/addresses")();
-
-  const headers$ = new Headers(compactMap({
-    "Content-Type": "application/json",
-    Accept: "application/json",
-    "SHIPPO-API-VERSION": encodeSimple(
-      "SHIPPO-API-VERSION",
-      client$._options.shippoApiVersion,
-      { explode: false, charEncoding: "none" },
-    ),
-  }));
-  const securityInput = await extractSecurity(client$._options.security);
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client$._options,
-    baseURL: options?.serverURL ?? client$._baseURL ?? "",
-    operationID: "CreateAddress",
-    oAuth2Scopes: null,
-    resolvedSecurity: requestSecurity,
-    securitySource: client$._options.security,
-    retryConfig: options?.retries
-      || client$._options.retryConfig
-      || { strategy: "none" },
-    retryCodes: options?.retryCodes || [
-      "429",
-      "500",
-      "502",
-      "503",
-      "504",
-    ],
-  };
-
-  const requestRes = client$._createRequest(context, {
-    security: requestSecurity,
-    method: "POST",
-    baseURL: options?.serverURL,
-    path: path$,
-    headers: headers$,
-    body: body$,
-    userAgent: client$._options.userAgent,
-    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
-      || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return [requestRes, { status: "invalid" }];
-  }
-  const req$ = requestRes.value;
-
-  const doResult = await client$._do(req$, {
-    context,
-    errorCodes: [],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return [doResult, { status: "request-error", request: req$ }];
-  }
-  const response = doResult.value;
-  const responseFields$ = {
-    HttpMeta: { Response: response, Request: req$ },
-  };
-
-  const [result$] = await M.match<
-    CreateAddressResponse,
-    | APIError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >(
-    M.json(201, CreateAddressResponse$zodSchema, { key: "Address" }),
-    M.json(400, CreateAddressResponse$zodSchema, { key: "BadRequest" }),
-  )(response, req$, { extraFields: responseFields$ });
-
-  return [result$, { status: "complete", request: req$, response }];
-}