@shippo/shippo-mcp 0.8.39 → 0.8.48

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/bin/mcp-server.js +125 -40
  2. package/bin/mcp-server.js.map +17 -17
  3. package/esm/funcs/batchesCreate.d.ts +9 -0
  4. package/esm/funcs/batchesCreate.d.ts.map +1 -1
  5. package/esm/funcs/batchesCreate.js +9 -0
  6. package/esm/funcs/batchesCreate.js.map +1 -1
  7. package/esm/funcs/batchesGet.d.ts +9 -4
  8. package/esm/funcs/batchesGet.d.ts.map +1 -1
  9. package/esm/funcs/batchesGet.js +9 -4
  10. package/esm/funcs/batchesGet.js.map +1 -1
  11. package/esm/lib/config.d.ts +2 -2
  12. package/esm/lib/config.js +2 -2
  13. package/esm/mcp-server/mcp-server.js +1 -1
  14. package/esm/mcp-server/server.js +1 -1
  15. package/esm/mcp-server/tools/batchesCreate.d.ts.map +1 -1
  16. package/esm/mcp-server/tools/batchesCreate.js +11 -1
  17. package/esm/mcp-server/tools/batchesCreate.js.map +1 -1
  18. package/esm/mcp-server/tools/batchesGet.d.ts.map +1 -1
  19. package/esm/mcp-server/tools/batchesGet.js +10 -4
  20. package/esm/mcp-server/tools/batchesGet.js.map +1 -1
  21. package/esm/mcp-server/tools/manifestsGet.d.ts.map +1 -1
  22. package/esm/mcp-server/tools/manifestsGet.js +10 -3
  23. package/esm/mcp-server/tools/manifestsGet.js.map +1 -1
  24. package/esm/mcp-server/tools/manifestsList.d.ts.map +1 -1
  25. package/esm/mcp-server/tools/manifestsList.js +10 -3
  26. package/esm/mcp-server/tools/manifestsList.js.map +1 -1
  27. package/esm/mcp-server/tools/trackingStatusGet.d.ts.map +1 -1
  28. package/esm/mcp-server/tools/trackingStatusGet.js +5 -0
  29. package/esm/mcp-server/tools/trackingStatusGet.js.map +1 -1
  30. package/esm/mcp-server/tools/transactionsCreate.d.ts.map +1 -1
  31. package/esm/mcp-server/tools/transactionsCreate.js +12 -0
  32. package/esm/mcp-server/tools/transactionsCreate.js.map +1 -1
  33. package/esm/mcp-server/tools/transactionsGet.d.ts.map +1 -1
  34. package/esm/mcp-server/tools/transactionsGet.js +7 -0
  35. package/esm/mcp-server/tools/transactionsGet.js.map +1 -1
  36. package/esm/mcp-server/tools/transactionsList.d.ts.map +1 -1
  37. package/esm/mcp-server/tools/transactionsList.js +7 -0
  38. package/esm/mcp-server/tools/transactionsList.js.map +1 -1
  39. package/esm/models/order.d.ts +39 -11
  40. package/esm/models/order.d.ts.map +1 -1
  41. package/esm/models/order.js +36 -11
  42. package/esm/models/order.js.map +1 -1
  43. package/esm/models/ordercreaterequest.d.ts +10 -10
  44. package/esm/models/ordercreaterequest.d.ts.map +1 -1
  45. package/esm/models/ordercreaterequest.js +10 -10
  46. package/esm/models/ordercreaterequest.js.map +1 -1
  47. package/manifest.json +9 -9
  48. package/package.json +1 -1
  49. package/src/funcs/batchesCreate.ts +9 -0
  50. package/src/funcs/batchesGet.ts +9 -4
  51. package/src/lib/config.ts +2 -2
  52. package/src/mcp-server/mcp-server.ts +1 -1
  53. package/src/mcp-server/server.ts +1 -1
  54. package/src/mcp-server/tools/batchesCreate.ts +11 -1
  55. package/src/mcp-server/tools/batchesGet.ts +10 -4
  56. package/src/mcp-server/tools/manifestsGet.ts +10 -3
  57. package/src/mcp-server/tools/manifestsList.ts +10 -3
  58. package/src/mcp-server/tools/trackingStatusGet.ts +5 -0
  59. package/src/mcp-server/tools/transactionsCreate.ts +12 -0
  60. package/src/mcp-server/tools/transactionsGet.ts +7 -0
  61. package/src/mcp-server/tools/transactionsList.ts +7 -0
  62. package/src/models/order.ts +84 -22
  63. package/src/models/ordercreaterequest.ts +20 -20
package/bin/mcp-server.js CHANGED
@@ -46623,9 +46623,9 @@ var init_config = __esm(() => {
46623
46623
  SDK_METADATA = {
46624
46624
  language: "typescript",
46625
46625
  openapiDocVersion: "2018-02-08",
46626
- sdkVersion: "0.8.39",
46626
+ sdkVersion: "0.8.48",
46627
46627
  genVersion: "2.770.0",
46628
- userAgent: "speakeasy-sdk/mcp-typescript 0.8.39 2.770.0 2018-02-08 @shippo/shippo-mcp"
46628
+ userAgent: "speakeasy-sdk/mcp-typescript 0.8.48 2.770.0 2018-02-08 @shippo/shippo-mcp"
46629
46629
  };
46630
46630
  });
46631
46631
 
@@ -49968,7 +49968,17 @@ var init_batchesCreate2 = __esm(() => {
49968
49968
  name: "batches-create",
49969
49969
  description: `Create a batch
49970
49970
 
49971
- Creates 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.`,
49971
+ Creates 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.
49972
+
49973
+ **IMPORTANT: There is NO batches-list endpoint in the Shippo API.**
49974
+ You must store the batch \`object_id\` returned from this endpoint to retrieve batches later using \`batches-get\`.
49975
+
49976
+ **Workflow:**
49977
+ 1. Create batch → Save the returned \`object_id\`
49978
+ 2. Retrieve batch status using \`batches-get\` with the saved ID
49979
+ 3. Add/remove shipments as needed
49980
+ 4. Purchase the batch when ready
49981
+ `,
49972
49982
  annotations: {
49973
49983
  title: "",
49974
49984
  destructiveHint: false,
@@ -50113,10 +50123,16 @@ var init_batchesGet2 = __esm(() => {
50113
50123
  name: "batches-get",
50114
50124
  description: `Retrieve a batch
50115
50125
 
50116
- Returns a batch using an object ID. <br> Batch shipments are displayed 100 at a time. You can iterate
50117
- through each \`page\` using the \`?page= query\` parameter. You can also filter based on batch shipment
50118
- status, for example, by passing a query param like \`?object_results=creation_failed\`. <br>
50119
- For more details on filtering results, see our guide on <a href="https://docs.goshippo.com/docs/api_concepts/filtering/" target="blank"> filtering</a>.`,
50126
+ Returns 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\`.
50127
+
50128
+ **IMPORTANT: There is NO batches-list endpoint in the Shippo API.**
50129
+ You must know the batch \`object_id\` (returned when you created the batch) to retrieve it.
50130
+ Store batch IDs when creating batches if you need to access them later.
50131
+
50132
+ **URL HANDLING:** This response contains \`label_url\` (array of download URLs).
50133
+ When displaying URLs, ALWAYS show the complete URL without truncation.
50134
+ Never replace parts with "..." - S3 signed URLs will break if truncated.
50135
+ `,
50120
50136
  annotations: {
50121
50137
  title: "",
50122
50138
  destructiveHint: false,
@@ -53614,15 +53630,22 @@ var init_manifestsGet2 = __esm(() => {
53614
53630
  };
53615
53631
  tool$manifestsGet = {
53616
53632
  name: "manifests-get",
53617
- description: `Retrieve a manifest
53618
-
53619
- Returns an existing manifest using an object ID.`,
53633
+ description: `Returns an existing manifest using an object ID.
53634
+
53635
+ **⚠️ URL HANDLING - CRITICAL:**
53636
+ The manifest contains a \`documents\` field with URLs to scan form PDFs.
53637
+ When displaying these URLs:
53638
+ - ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with "..."
53639
+ - These are S3 signed URLs that break if modified
53640
+ - Display URLs in a code block AND as a clickable hyperlink
53641
+ `,
53642
+ scopes: ["read"],
53620
53643
  annotations: {
53621
53644
  title: "",
53622
53645
  destructiveHint: false,
53623
53646
  idempotentHint: false,
53624
53647
  openWorldHint: false,
53625
- readOnlyHint: true
53648
+ readOnlyHint: false
53626
53649
  },
53627
53650
  args: args26,
53628
53651
  tool: async (client, args27, ctx) => {
@@ -53766,15 +53789,22 @@ var init_manifestsList2 = __esm(() => {
53766
53789
  };
53767
53790
  tool$manifestsList = {
53768
53791
  name: "manifests-list",
53769
- description: `List all manifests
53770
-
53771
- Returns a list of all manifest objects.`,
53792
+ description: `Returns a list of all manifest objects.
53793
+
53794
+ **⚠️ URL HANDLING - CRITICAL:**
53795
+ Each manifest contains a \`documents\` field with URLs to scan form PDFs.
53796
+ When displaying these URLs:
53797
+ - ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with "..."
53798
+ - These are S3 signed URLs that break if modified
53799
+ - Display URLs in a code block AND as a clickable hyperlink
53800
+ `,
53801
+ scopes: ["read"],
53772
53802
  annotations: {
53773
53803
  title: "",
53774
53804
  destructiveHint: false,
53775
53805
  idempotentHint: false,
53776
53806
  openWorldHint: false,
53777
- readOnlyHint: true
53807
+ readOnlyHint: false
53778
53808
  },
53779
53809
  args: args27,
53780
53810
  tool: async (client, args28, ctx) => {
@@ -53853,35 +53883,59 @@ var init_orderstatusenum = __esm(() => {
53853
53883
  });
53854
53884
 
53855
53885
  // src/models/order.ts
53856
- var OrderTransaction$zodSchema, Order$zodSchema;
53886
+ var OrderAddressFrom$zodSchema, OrderTransaction$zodSchema, Order$zodSchema;
53857
53887
  var init_order = __esm(() => {
53858
53888
  init_zod();
53859
53889
  init_address();
53890
+ init_addressvalidationresults();
53860
53891
  init_lineitem();
53861
53892
  init_ordershopappenum();
53862
53893
  init_orderstatusenum();
53863
53894
  init_weightunitenum();
53895
+ OrderAddressFrom$zodSchema = objectType({
53896
+ city: stringType().optional(),
53897
+ company: stringType().optional(),
53898
+ country: stringType(),
53899
+ email: stringType().optional(),
53900
+ is_complete: booleanType().optional(),
53901
+ is_residential: booleanType().nullable().optional(),
53902
+ metadata: stringType().optional(),
53903
+ name: stringType().optional(),
53904
+ object_created: stringType().datetime({ offset: true }).optional(),
53905
+ object_id: stringType().optional(),
53906
+ object_owner: stringType().optional(),
53907
+ object_updated: stringType().datetime({ offset: true }).optional(),
53908
+ phone: stringType().optional(),
53909
+ state: stringType().optional(),
53910
+ street1: stringType().optional(),
53911
+ street2: stringType().optional(),
53912
+ street3: stringType().optional(),
53913
+ street_no: stringType().optional(),
53914
+ test: booleanType().nullable().optional(),
53915
+ validation_results: AddressValidationResults$zodSchema.optional(),
53916
+ zip: stringType().optional()
53917
+ }).describe('<a href="#tag/Addresses">Address</a> object of the sender / seller. Will be returned expanded by default.');
53864
53918
  OrderTransaction$zodSchema = objectType({});
53865
53919
  Order$zodSchema = objectType({
53866
- currency: stringType().optional(),
53867
- from_address: Address$zodSchema.optional(),
53920
+ currency: stringType().nullable().optional(),
53921
+ from_address: lazyType(() => OrderAddressFrom$zodSchema).nullable().optional(),
53868
53922
  line_items: arrayType(LineItem$zodSchema).optional(),
53869
- notes: stringType().optional(),
53923
+ notes: stringType().nullable().optional(),
53870
53924
  object_id: stringType().optional(),
53871
53925
  object_owner: stringType().optional(),
53872
- order_number: stringType().optional(),
53926
+ order_number: stringType().nullable().optional(),
53873
53927
  order_status: OrderStatusEnum$zodSchema.optional(),
53874
53928
  placed_at: stringType(),
53875
- shipping_cost: stringType().optional(),
53876
- shipping_cost_currency: stringType().optional(),
53877
- shipping_method: stringType().optional(),
53929
+ shipping_cost: stringType().nullable().optional(),
53930
+ shipping_cost_currency: stringType().nullable().optional(),
53931
+ shipping_method: stringType().nullable().optional(),
53878
53932
  shop_app: OrderShopAppEnum$zodSchema.optional(),
53879
- subtotal_price: stringType().optional(),
53933
+ subtotal_price: stringType().nullable().optional(),
53880
53934
  to_address: Address$zodSchema,
53881
- total_price: stringType().optional(),
53882
- total_tax: stringType().optional(),
53935
+ total_price: stringType().nullable().optional(),
53936
+ total_tax: stringType().nullable().optional(),
53883
53937
  transactions: arrayType(lazyType(() => OrderTransaction$zodSchema)).optional(),
53884
- weight: stringType().optional(),
53938
+ weight: stringType().nullable().optional(),
53885
53939
  weight_unit: WeightUnitEnum$zodSchema.optional()
53886
53940
  });
53887
53941
  });
@@ -53933,21 +53987,21 @@ var init_ordercreaterequest = __esm(() => {
53933
53987
  init_orderstatusenum();
53934
53988
  init_weightunitenum();
53935
53989
  OrderCreateRequest$zodSchema = objectType({
53936
- currency: stringType().optional(),
53990
+ currency: stringType().nullable().optional(),
53937
53991
  from_address: AddressCreateRequest$zodSchema.optional(),
53938
53992
  line_items: arrayType(LineItemBase$zodSchema).optional(),
53939
- notes: stringType().optional(),
53940
- order_number: stringType().optional(),
53993
+ notes: stringType().nullable().optional(),
53994
+ order_number: stringType().nullable().optional(),
53941
53995
  order_status: OrderStatusEnum$zodSchema.optional(),
53942
53996
  placed_at: stringType(),
53943
- shipping_cost: stringType().optional(),
53944
- shipping_cost_currency: stringType().optional(),
53945
- shipping_method: stringType().optional(),
53946
- subtotal_price: stringType().optional(),
53997
+ shipping_cost: stringType().nullable().optional(),
53998
+ shipping_cost_currency: stringType().nullable().optional(),
53999
+ shipping_method: stringType().nullable().optional(),
54000
+ subtotal_price: stringType().nullable().optional(),
53947
54001
  to_address: AddressCreateRequest$zodSchema,
53948
- total_price: stringType().optional(),
53949
- total_tax: stringType().optional(),
53950
- weight: stringType().optional(),
54002
+ total_price: stringType().nullable().optional(),
54003
+ total_tax: stringType().nullable().optional(),
54004
+ weight: stringType().nullable().optional(),
53951
54005
  weight_unit: WeightUnitEnum$zodSchema.optional()
53952
54006
  });
53953
54007
  });
@@ -58842,6 +58896,11 @@ not the actual carrier names like 'USPS', 'UPS', 'FedEx', etc.
58842
58896
  \`\`\`
58843
58897
 
58844
58898
  The API will return an error if you use real carrier names with test tokens.
58899
+
58900
+ **⚠️ URL HANDLING - CRITICAL:**
58901
+ The response may include tracking URLs. When displaying any URLs:
58902
+ - ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with "..."
58903
+ - Display URLs in a code block AND as a clickable hyperlink
58845
58904
  `,
58846
58905
  scopes: ["read", "tracking"],
58847
58906
  annotations: {
@@ -59147,6 +59206,18 @@ First create a shipment to get rates, then use this tool with the rate ID.
59147
59206
  - \`QUEUED\` → Processing (keep polling)
59148
59207
  - \`SUCCESS\` → ✅ Label ready! Check label_url and tracking_number
59149
59208
  - \`ERROR\` → ❌ Check messages for details
59209
+
59210
+ **⚠️ URL HANDLING - CRITICAL:**
59211
+ When transaction succeeds, the response includes:
59212
+ - \`label_url\`: S3 signed URL for shipping label download
59213
+ - \`qr_code_url\`: QR code image URL (if requested)
59214
+ - \`tracking_url_provider\`: Carrier's tracking page URL
59215
+
59216
+ **When displaying these URLs:**
59217
+ - ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with "..."
59218
+ - S3 signed URLs contain required query parameters (Signature, Expires, AWSAccessKeyId)
59219
+ - Truncating these URLs will make them non-functional
59220
+ - Display URLs in a code block AND as a clickable hyperlink
59150
59221
  `,
59151
59222
  scopes: ["write"],
59152
59223
  annotations: {
@@ -59314,6 +59385,13 @@ var init_transactionsGet2 = __esm(() => {
59314
59385
 
59315
59386
  **Required Parameter:**
59316
59387
  - \`TransactionId\`: The transaction object ID from transaction creation
59388
+
59389
+ **⚠️ URL HANDLING - CRITICAL:**
59390
+ When displaying URLs from this response (label_url, qr_code_url, tracking_url_provider):
59391
+ - ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with "..."
59392
+ - These are S3 signed URLs with required query parameters (Signature, Expires, AWSAccessKeyId)
59393
+ - Truncating these URLs will make them non-functional
59394
+ - Display URLs in a code block AND as a clickable hyperlink
59317
59395
  `,
59318
59396
  scopes: ["read"],
59319
59397
  annotations: {
@@ -59505,6 +59583,13 @@ This tool lists transaction objects, which represent purchased shipping labels.
59505
59583
 
59506
59584
  **Note on Test Mode:**
59507
59585
  Test transactions will always show \`tracking_status: "UNKNOWN"\` because they don't receive real carrier tracking updates.
59586
+
59587
+ **⚠️ URL HANDLING - CRITICAL:**
59588
+ Each transaction may include URLs (label_url, qr_code_url, tracking_url_provider).
59589
+ When displaying these URLs:
59590
+ - ALWAYS show the COMPLETE URL - NEVER truncate or replace parts with "..."
59591
+ - These are S3 signed URLs that break if modified
59592
+ - Display URLs in a code block AND as a clickable hyperlink
59508
59593
  `,
59509
59594
  scopes: ["read"],
59510
59595
  annotations: {
@@ -61062,7 +61147,7 @@ Updates an existing webhook using the webhook object ID.`,
61062
61147
  function createMCPServer(deps) {
61063
61148
  const server = new McpServer({
61064
61149
  name: "ShippoSDK",
61065
- version: "0.8.39"
61150
+ version: "0.8.48"
61066
61151
  });
61067
61152
  const getClient = deps.getSDK || (() => new ShippoSDKCore({
61068
61153
  security: deps.security,
@@ -62454,7 +62539,7 @@ var routes = ln({
62454
62539
  var app = _e(routes, {
62455
62540
  name: "mcp",
62456
62541
  versionInfo: {
62457
- currentVersion: "0.8.39"
62542
+ currentVersion: "0.8.48"
62458
62543
  }
62459
62544
  });
62460
62545
  Yt(app, process3.argv.slice(2), buildContext(process3));
@@ -62462,5 +62547,5 @@ export {
62462
62547
  app
62463
62548
  };
62464
62549
 
62465
- //# debugId=2953EB7A367B100264756E2164756E21
62550
+ //# debugId=664682E46076BBF464756E2164756E21
62466
62551
  //# sourceMappingURL=mcp-server.js.map