@shippo/shippo-mcp 0.5.0

package/esm/types/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/types/enums.ts"],"names":[],"mappings":"AAAA;;GAEG;AAKH,MAAM,UAAU,qBAAqB,CAAI,KAAQ;IAC/C,OAAO,KAAwB,CAAC;AAClC,CAAC"}

package/esm/types/fp.d.ts

@@ -0,0 +1,31 @@
+/**
+ * A monad that captures the result of a function call or an error if it was not
+ * successful. Railway programming, enabled by this type, can be a nicer
+ * alternative to traditional exception throwing because it allows functions to
+ * declare all _known_ errors with static types and then check for them
+ * exhaustively in application code. Thrown exception have a type of `unknown`
+ * and break out of regular control flow of programs making them harder to
+ * inspect and more verbose work with due to try-catch blocks.
+ */
+export type Result<T, E = unknown> = {
+    ok: true;
+    value: T;
+    error?: never;
+} | {
+    ok: false;
+    value?: never;
+    error: E;
+};
+export declare function OK<V>(value: V): Result<V, never>;
+export declare function ERR<E>(error: E): Result<never, E>;
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+export declare function unwrap<T>(r: Result<T, unknown>): T;
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+export declare function unwrapAsync<T>(pr: Promise<Result<T, unknown>>): Promise<T>;
+//# sourceMappingURL=fp.d.ts.map

package/esm/types/fp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fp.d.ts","sourceRoot":"","sources":["../../src/types/fp.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,OAAO,IAC7B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,GACrC;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE3C,wBAAgB,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,CAEhD;AAED,wBAAgB,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAEjD;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,CAKlD;AAED;;;GAGG;AACH,wBAAsB,WAAW,CAAC,CAAC,EACjC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,GAC9B,OAAO,CAAC,CAAC,CAAC,CAOZ"}

package/esm/types/fp.js

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+export function OK(value) {
+    return { ok: true, value };
+}
+export function ERR(error) {
+    return { ok: false, error };
+}
+/**
+ * unwrap is a convenience function for extracting a value from a result or
+ * throwing if there was an error.
+ */
+export function unwrap(r) {
+    if (!r.ok) {
+        throw r.error;
+    }
+    return r.value;
+}
+/**
+ * unwrapAsync is a convenience function for resolving a value from a Promise
+ * of a result or rejecting if an error occurred.
+ */
+export async function unwrapAsync(pr) {
+    const r = await pr;
+    if (!r.ok) {
+        throw r.error;
+    }
+    return r.value;
+}
+//# sourceMappingURL=fp.js.map

package/esm/types/fp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fp.js","sourceRoot":"","sources":["../../src/types/fp.ts"],"names":[],"mappings":"AAAA;;GAEG;AAeH,MAAM,UAAU,EAAE,CAAI,KAAQ;IAC5B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,GAAG,CAAI,KAAQ;IAC7B,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC9B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAI,CAAqB;IAC7C,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACV,MAAM,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IACD,OAAO,CAAC,CAAC,KAAK,CAAC;AACjB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,EAA+B;IAE/B,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QACV,MAAM,CAAC,CAAC,KAAK,CAAC;IAChB,CAAC;IAED,OAAO,CAAC,CAAC,KAAK,CAAC;AACjB,CAAC"}

package/esm/types/rfcdate.d.ts

@@ -0,0 +1,21 @@
+export declare class RFCDate {
+    private serialized;
+    /**
+     * Creates a new RFCDate instance using today's date.
+     */
+    static today(): RFCDate;
+    /**
+     * Creates a new RFCDate instance using the provided input.
+     * If a string is used then in must be in the format YYYY-MM-DD.
+     *
+     * @param date A Date object or a date string in YYYY-MM-DD format
+     * @example
+     * new RFCDate("2022-01-01")
+     * @example
+     * new RFCDate(new Date())
+     */
+    constructor(date: Date | string);
+    toJSON(): string;
+    toString(): string;
+}
+//# sourceMappingURL=rfcdate.d.ts.map

package/esm/types/rfcdate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rfcdate.d.ts","sourceRoot":"","sources":["../../src/types/rfcdate.ts"],"names":[],"mappings":"AAMA,qBAAa,OAAO;IAClB,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,MAAM,CAAC,KAAK,IAAI,OAAO;IAIvB;;;;;;;;;OASG;gBACS,IAAI,EAAE,IAAI,GAAG,MAAM;IAoB/B,MAAM,IAAI,MAAM;IAIhB,QAAQ,IAAI,MAAM;CAGnB"}

package/esm/types/rfcdate.js

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+const dateRE = /^\d{4}-\d{2}-\d{2}$/;
+export class RFCDate {
+    serialized;
+    /**
+     * Creates a new RFCDate instance using today's date.
+     */
+    static today() {
+        return new RFCDate(new Date());
+    }
+    /**
+     * Creates a new RFCDate instance using the provided input.
+     * If a string is used then in must be in the format YYYY-MM-DD.
+     *
+     * @param date A Date object or a date string in YYYY-MM-DD format
+     * @example
+     * new RFCDate("2022-01-01")
+     * @example
+     * new RFCDate(new Date())
+     */
+    constructor(date) {
+        if (typeof date === "string" && !dateRE.test(date)) {
+            throw new RangeError("RFCDate: date strings must be in the format YYYY-MM-DD: " + date);
+        }
+        const value = new Date(date);
+        if (isNaN(+value)) {
+            throw new RangeError("RFCDate: invalid date provided: " + date);
+        }
+        this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length);
+        if (!dateRE.test(this.serialized)) {
+            throw new TypeError(`RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`);
+        }
+    }
+    toJSON() {
+        return this.toString();
+    }
+    toString() {
+        return this.serialized;
+    }
+}
+//# sourceMappingURL=rfcdate.js.map

package/esm/types/rfcdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rfcdate.js","sourceRoot":"","sources":["../../src/types/rfcdate.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,GAAG,qBAAqB,CAAC;AAErC,MAAM,OAAO,OAAO;IACV,UAAU,CAAS;IAE3B;;OAEG;IACH,MAAM,CAAC,KAAK;QACV,OAAO,IAAI,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,IAAmB;QAC7B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,UAAU,CAClB,0DAA0D,GAAG,IAAI,CAClE,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,UAAU,CAAC,kCAAkC,GAAG,IAAI,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,SAAS,CACjB,yDAAyD,IAAI,kBAAkB,IAAI,CAAC,UAAU,EAAE,CACjG,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF"}

package/esm/types/streams.d.ts

@@ -0,0 +1,2 @@
+export declare function isReadableStream<T = Uint8Array>(val: unknown): val is ReadableStream<T>;
+//# sourceMappingURL=streams.d.ts.map

package/esm/types/streams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streams.d.ts","sourceRoot":"","sources":["../../src/types/streams.ts"],"names":[],"mappings":"AAIA,wBAAgB,gBAAgB,CAAC,CAAC,GAAG,UAAU,EAC7C,GAAG,EAAE,OAAO,GACX,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,CAc1B"}

package/esm/types/streams.js

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+export function isReadableStream(val) {
+    if (typeof val !== "object" || val === null) {
+        return false;
+    }
+    // Check for the presence of methods specific to ReadableStream
+    const stream = val;
+    // ReadableStream has methods like getReader, cancel, and tee
+    return (typeof stream.getReader === "function" &&
+        typeof stream.cancel === "function" &&
+        typeof stream.tee === "function");
+}
+//# sourceMappingURL=streams.js.map

package/esm/types/streams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streams.js","sourceRoot":"","sources":["../../src/types/streams.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,UAAU,gBAAgB,CAC9B,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IAC/D,MAAM,MAAM,GAAG,GAAiC,CAAC;IAEjD,6DAA6D;IAC7D,OAAO,CACL,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU;QACtC,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU;QACnC,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU,CACjC,CAAC;AACJ,CAAC"}

package/manifest.json

@@ -0,0 +1,334 @@
+{
+  "manifest_version": "0.3",
+  "name": "@shippo/shippo-mcp",
+  "version": "0.1.9",
+  "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",
+  "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-or-validate",
+      "description": "**PREFERRED TOOL FOR ADDRESS VALIDATION AND CREATION** - Use this tool when asked to validate or create addresses.\n\nThis is the standard Shippo address validation and creation flow. When users request address validation,\nuse this tool with validate=true parameter.\n\nExample usage for validation:\n\\`\\`\\`\nPOST /addresses\n{\n  \"name\": \"Shawn Ippotle\",\n  \"company\": \"Shippo\", \n  \"street1\": \"215 Clayton St.\",\n  \"city\": \"San Francisco\",\n  \"state\": \"CA\",\n  \"zip\": \"94117\",\n  \"country\": \"US\",\n  \"email\": \"shippotle@shippo.com\",\n  \"validate\": true\n}\n\\`\\`\\`\n\nWhen validate=true is set, this endpoint:\n- Validates address accuracy and deliverability\n- Returns standardized formatting (street abbreviations, proper casing)\n- Provides extended ZIP+4 codes when available\n- Determines residential vs commercial classification\n- Returns validation results and any corrections\n- Creates the address record for future use\n\nUse this tool for both address validation AND creating address records for shipments.\n"
+    },
+    {
+      "name": "addresses-get",
+      "description": "Retrieve an address\n\nReturns an existing address using an object ID."
+    },
+    {
+      "name": "addresses-validate-existing",
+      "description": "**SECONDARY VALIDATION TOOL** - Validates an already created address using its ID.\n\nUse this tool only when you have an existing address ID and need to re-validate it.\nFor new address validation, prefer the addresses-create tool with validate=true.\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."
+    },
+    {
+      "name": "batches-get",
+      "description": "Retrieve a batch\n\nReturns a batch using an object ID. <br> Batch shipments are displayed 100 at a time.  You can iterate \nthrough each \\`page\\` using the \\`?page= query\\` parameter.  You can also filter based on batch shipment \nstatus, for example, by passing a query param like \\`?object_results=creation_failed\\`. <br> \nFor more details on filtering results, see our guide on <a href=\"https://docs.goshippo.com/docs/api_concepts/filtering/\" target=\"blank\"> filtering</a>."
+    },
+    {
+      "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": "List all manifests\n\nReturns a list of all manifest objects."
+    },
+    {
+      "name": "manifests-create",
+      "description": "Create a new manifest\n\nCreates a new manifest object."
+    },
+    {
+      "name": "manifests-get",
+      "description": "Retrieve a manifest\n\nReturns an existing manifest using an object ID."
+    },
+    {
+      "name": "orders-list",
+      "description": "List all orders\n\nReturns a list of all order objects."
+    },
+    {
+      "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": "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 all shipments\n\nReturns a list of all shipment objects.<br><br>\nIn order to filter results, you must use the below path parameters. \nA maximum date range of 90 days is permitted. \nProvided dates should be ISO 8601 UTC dates (timezone offsets are currently not supported).<br><br>\n\nOptional path parameters:<br>\n  \\`object_created_gt\\`- object(s) created greater than a provided date time<br>\n  \\`object_created_gte\\` - object(s) created greater than or equal to a provided date time<br>\n  \\`object_created_lt\\` - object(s) created less than a provided date time<br>\n  \\`object_created_lte\\` - object(s) created less than or equal to a provided date time<br>\n\n  Date format examples:<br>\n    \\`2017-01-01\\`<br>\n    \\`2017-01-01T03:30:30\\` or \\`2017-01-01T03:30:30.5\\`<br>\n    \\`2017-01-01T03:30:30Z\\`<br><br>\n\n  Example URL:<br>\n    \\`https://api.goshippo.com/shipments/?object_created_gte=2017-01-01T00:00:30&object_created_lt=2017-04-01T00:00:30\\`"
+    },
+    {
+      "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"
+    },
+    {
+      "name": "transactions-list",
+      "description": "List all shipping labels\n\nReturns a list of all transaction objects."
+    },
+    {
+      "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"
+    },
+    {
+      "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"
+    },
+    {
+      "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."
+    }
+  ],
+  "prompts": [],
+  "keywords": [
+      "@shippo",
+      "mcp/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
+      }
+    }
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@shippo/shippo-mcp",
+  "version": "0.5.0",
+  "author": "shippo",
+  "type": "module",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goshippo/shippo-mcp.git"
+  },
+  "bin": {
+    "@shippo/shippo-mcp": "bin/mcp-server.js",
+    "mcp": "bin/mcp-server.js"
+  },
+  "scripts": {
+    "build": "bun i && bun src/mcp-server/build.mts && tsc",
+    "check": "npm run lint",
+    "lint": "eslint --cache --max-warnings=0 src",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.17.0",
+    "@stricli/core": "^1.1.2",
+    "bun": "^1.2.12",
+    "express": "^5.1.0",
+    "zod": "^3.25.7"
+  },
+  "devDependencies": {
+    "@anthropic-ai/mcpb": "^1.2.0",
+    "@eslint/js": "^9.26.0",
+    "@types/bun": "^1.2.13",
+    "@types/express": "^5.0.1",
+    "@types/node": "^22.15.20",
+    "eslint": "^9.26.0",
+    "globals": "^16.0.0",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "^8.31.1"
+  }
+}

package/src/core.ts

@@ -0,0 +1,13 @@
+/*
+ * 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 {}