@teamnetwork-nz/gosweetspot-mcp-server 0.1.0
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.
- package/README.md +174 -0
- package/dist/client.d.ts +29 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +95 -0
- package/dist/client.js.map +1 -0
- package/dist/config.d.ts +10 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +33 -0
- package/dist/config.js.map +1 -0
- package/dist/datetime.d.ts +5 -0
- package/dist/datetime.d.ts.map +1 -0
- package/dist/datetime.js +65 -0
- package/dist/datetime.js.map +1 -0
- package/dist/format.d.ts +4 -0
- package/dist/format.d.ts.map +1 -0
- package/dist/format.js +58 -0
- package/dist/format.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +77 -0
- package/dist/index.js.map +1 -0
- package/dist/schemas/models.d.ts +118 -0
- package/dist/schemas/models.d.ts.map +1 -0
- package/dist/schemas/models.js +43 -0
- package/dist/schemas/models.js.map +1 -0
- package/dist/tools/address.d.ts +3 -0
- package/dist/tools/address.d.ts.map +1 -0
- package/dist/tools/address.js +28 -0
- package/dist/tools/address.js.map +1 -0
- package/dist/tools/connection.d.ts +3 -0
- package/dist/tools/connection.d.ts.map +1 -0
- package/dist/tools/connection.js +42 -0
- package/dist/tools/connection.js.map +1 -0
- package/dist/tools/customerorders.d.ts +3 -0
- package/dist/tools/customerorders.d.ts.map +1 -0
- package/dist/tools/customerorders.js +87 -0
- package/dist/tools/customerorders.js.map +1 -0
- package/dist/tools/index.d.ts +3 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +19 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/manifest.d.ts +3 -0
- package/dist/tools/manifest.d.ts.map +1 -0
- package/dist/tools/manifest.js +21 -0
- package/dist/tools/manifest.js.map +1 -0
- package/dist/tools/pickup.d.ts +3 -0
- package/dist/tools/pickup.d.ts.map +1 -0
- package/dist/tools/pickup.js +26 -0
- package/dist/tools/pickup.js.map +1 -0
- package/dist/tools/printing.d.ts +3 -0
- package/dist/tools/printing.d.ts.map +1 -0
- package/dist/tools/printing.js +64 -0
- package/dist/tools/printing.js.map +1 -0
- package/dist/tools/rates.d.ts +3 -0
- package/dist/tools/rates.d.ts.map +1 -0
- package/dist/tools/rates.js +34 -0
- package/dist/tools/rates.js.map +1 -0
- package/dist/tools/shipments.d.ts +3 -0
- package/dist/tools/shipments.d.ts.map +1 -0
- package/dist/tools/shipments.js +131 -0
- package/dist/tools/shipments.js.map +1 -0
- package/dist/types.d.ts +7 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +5 -0
- package/dist/types.js.map +1 -0
- package/package.json +42 -0
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { jsonBlock } from '../format.js';
|
|
3
|
+
import { toUtcIso } from '../datetime.js';
|
|
4
|
+
import { contactSchema, packageSchema } from '../schemas/models.js';
|
|
5
|
+
export const shipmentTools = [
|
|
6
|
+
{
|
|
7
|
+
name: 'gss_list_shipments',
|
|
8
|
+
description: 'Retrieve historically created shipments including current status and tracking. Filter by consignment numbers, order numbers, or a last-updated date range. When consignment/order numbers are supplied, the date filters are ignored.',
|
|
9
|
+
inputSchema: z
|
|
10
|
+
.object({
|
|
11
|
+
shipments: z
|
|
12
|
+
.string()
|
|
13
|
+
.optional()
|
|
14
|
+
.describe('Comma-separated list of consignment numbers to filter on'),
|
|
15
|
+
ordernumbers: z
|
|
16
|
+
.string()
|
|
17
|
+
.optional()
|
|
18
|
+
.describe('Comma-separated list of order numbers to filter on'),
|
|
19
|
+
lastupdateminutc: z
|
|
20
|
+
.string()
|
|
21
|
+
.optional()
|
|
22
|
+
.describe('Earliest last-updated datetime (ISO; converted to UTC)'),
|
|
23
|
+
lastupdatemaxutc: z
|
|
24
|
+
.string()
|
|
25
|
+
.optional()
|
|
26
|
+
.describe('Latest last-updated datetime (ISO; converted to UTC)'),
|
|
27
|
+
includeDangerousGoodsFlag: z
|
|
28
|
+
.boolean()
|
|
29
|
+
.optional()
|
|
30
|
+
.describe('Populate the IsDangerousGoods field'),
|
|
31
|
+
excludeDeletedShipments: z
|
|
32
|
+
.boolean()
|
|
33
|
+
.optional()
|
|
34
|
+
.describe('Exclude deleted shipments from the results'),
|
|
35
|
+
page: z.number().int().positive().optional().describe('Page number (default 1)'),
|
|
36
|
+
pagesize: z
|
|
37
|
+
.number()
|
|
38
|
+
.int()
|
|
39
|
+
.positive()
|
|
40
|
+
.max(250)
|
|
41
|
+
.optional()
|
|
42
|
+
.describe('Records per page (max 250, default 250)'),
|
|
43
|
+
})
|
|
44
|
+
.strict(),
|
|
45
|
+
handler: async (client, args) => {
|
|
46
|
+
const params = { ...args };
|
|
47
|
+
if (args.lastupdateminutc)
|
|
48
|
+
params['lastupdateminutc'] = toUtcIso(args.lastupdateminutc);
|
|
49
|
+
if (args.lastupdatemaxutc)
|
|
50
|
+
params['lastupdatemaxutc'] = toUtcIso(args.lastupdatemaxutc);
|
|
51
|
+
if (params['pagesize'] === undefined)
|
|
52
|
+
params['pagesize'] = client.getDefaultPageSize();
|
|
53
|
+
const data = await client.get('/api/shipments', params);
|
|
54
|
+
return jsonBlock('Shipments', data);
|
|
55
|
+
},
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
name: 'gss_get_shipment_status',
|
|
59
|
+
description: 'Get current status and line-level tracking events for one or more shipments by consignment number. Read-only.',
|
|
60
|
+
inputSchema: z
|
|
61
|
+
.object({
|
|
62
|
+
consignments: z
|
|
63
|
+
.array(z.string())
|
|
64
|
+
.min(1)
|
|
65
|
+
.describe('List of consignment (connote) numbers to look up'),
|
|
66
|
+
})
|
|
67
|
+
.strict(),
|
|
68
|
+
handler: async (client, args) => {
|
|
69
|
+
const data = await client.postQuery('/v2/shipmentstatus', args.consignments);
|
|
70
|
+
return jsonBlock('Shipment status', data);
|
|
71
|
+
},
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
name: 'gss_create_shipment',
|
|
75
|
+
description: '[write] Create a new shipment. Provide a QuoteId from gss_get_rates to use a chosen rate, or a Carrier name to auto-rate. Printing can be triggered by setting PrintToPrinter. Returns the consignment(s) with connote, tracking URL and cost.',
|
|
76
|
+
inputSchema: z
|
|
77
|
+
.object({
|
|
78
|
+
Destination: contactSchema.describe('Delivery destination'),
|
|
79
|
+
Origin: contactSchema
|
|
80
|
+
.optional()
|
|
81
|
+
.nullable()
|
|
82
|
+
.describe('Pickup origin. Omit/null to use the site’s configured address.'),
|
|
83
|
+
Packages: z.array(packageSchema).min(1).describe('One or more packages to ship'),
|
|
84
|
+
QuoteId: z
|
|
85
|
+
.string()
|
|
86
|
+
.optional()
|
|
87
|
+
.describe('QuoteId from a prior gss_get_rates call to lock in that rate'),
|
|
88
|
+
Carrier: z
|
|
89
|
+
.string()
|
|
90
|
+
.optional()
|
|
91
|
+
.describe('Carrier name for auto-rating, e.g. "Post Haste" (used when no QuoteId)'),
|
|
92
|
+
DeliveryReference: z.string().max(60).optional().describe('Your delivery reference'),
|
|
93
|
+
IsSignatureRequired: z.boolean().optional().describe('Require signature on delivery'),
|
|
94
|
+
IsSaturdayDelivery: z.boolean().optional().describe('Request Saturday delivery'),
|
|
95
|
+
IsUrgentCouriers: z.boolean().optional().describe('Use urgent couriers'),
|
|
96
|
+
DutiesAndTaxesByReceiver: z
|
|
97
|
+
.boolean()
|
|
98
|
+
.optional()
|
|
99
|
+
.describe('Receiver pays duties and taxes'),
|
|
100
|
+
PrintToPrinter: z
|
|
101
|
+
.string()
|
|
102
|
+
.optional()
|
|
103
|
+
.describe('Printer name to auto-print labels to, or "false" to skip printing'),
|
|
104
|
+
})
|
|
105
|
+
.strict(),
|
|
106
|
+
handler: async (client, args) => {
|
|
107
|
+
const data = await client.post('/api/shipments', args);
|
|
108
|
+
return jsonBlock('Shipment created', data);
|
|
109
|
+
},
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
name: 'gss_delete_shipments',
|
|
113
|
+
description: '[write] Delete one or more unprocessed shipments by consignment number (max 50 per call). Manifested, in-transit or delivered shipments cannot be deleted. Returns per-consignment outcomes.',
|
|
114
|
+
inputSchema: z
|
|
115
|
+
.object({
|
|
116
|
+
consignments: z
|
|
117
|
+
.array(z.string())
|
|
118
|
+
.min(1)
|
|
119
|
+
.max(50)
|
|
120
|
+
.describe('Consignment numbers to delete (max 50)'),
|
|
121
|
+
})
|
|
122
|
+
.strict(),
|
|
123
|
+
handler: async (client, args) => {
|
|
124
|
+
const data = await client.delete('/api/shipments', {
|
|
125
|
+
id: args.consignments.join(','),
|
|
126
|
+
});
|
|
127
|
+
return jsonBlock('Shipment deletion results', data);
|
|
128
|
+
},
|
|
129
|
+
},
|
|
130
|
+
];
|
|
131
|
+
//# sourceMappingURL=shipments.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"shipments.js","sourceRoot":"","sources":["../../src/tools/shipments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAEpE,MAAM,CAAC,MAAM,aAAa,GAAqB;IAC7C;QACE,IAAI,EAAE,oBAAoB;QAC1B,WAAW,EACT,uOAAuO;QACzO,WAAW,EAAE,CAAC;aACX,MAAM,CAAC;YACN,SAAS,EAAE,CAAC;iBACT,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,0DAA0D,CAAC;YACvE,YAAY,EAAE,CAAC;iBACZ,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,oDAAoD,CAAC;YACjE,gBAAgB,EAAE,CAAC;iBAChB,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,wDAAwD,CAAC;YACrE,gBAAgB,EAAE,CAAC;iBAChB,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,sDAAsD,CAAC;YACnE,yBAAyB,EAAE,CAAC;iBACzB,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CAAC,qCAAqC,CAAC;YAClD,uBAAuB,EAAE,CAAC;iBACvB,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CAAC,4CAA4C,CAAC;YACzD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;YAChF,QAAQ,EAAE,CAAC;iBACR,MAAM,EAAE;iBACR,GAAG,EAAE;iBACL,QAAQ,EAAE;iBACV,GAAG,CAAC,GAAG,CAAC;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,yCAAyC,CAAC;SACvD,CAAC;aACD,MAAM,EAAE;QACX,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YAC9B,MAAM,MAAM,GAA4B,EAAE,GAAG,IAAI,EAAE,CAAC;YACpD,IAAI,IAAI,CAAC,gBAAgB;gBAAE,MAAM,CAAC,kBAAkB,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACxF,IAAI,IAAI,CAAC,gBAAgB;gBAAE,MAAM,CAAC,kBAAkB,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACxF,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,SAAS;gBAAE,MAAM,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,kBAAkB,EAAE,CAAC;YACvF,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,GAAG,CAAU,gBAAgB,EAAE,MAAM,CAAC,CAAC;YACjE,OAAO,SAAS,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACtC,CAAC;KACF;IAED;QACE,IAAI,EAAE,yBAAyB;QAC/B,WAAW,EACT,+GAA+G;QACjH,WAAW,EAAE,CAAC;aACX,MAAM,CAAC;YACN,YAAY,EAAE,CAAC;iBACZ,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,CAAC,kDAAkD,CAAC;SAChE,CAAC;aACD,MAAM,EAAE;QACX,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YAC9B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAU,oBAAoB,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;YACtF,OAAO,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;KACF;IAED;QACE,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EACT,gPAAgP;QAClP,WAAW,EAAE,CAAC;aACX,MAAM,CAAC;YACN,WAAW,EAAE,aAAa,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YAC3D,MAAM,EAAE,aAAa;iBAClB,QAAQ,EAAE;iBACV,QAAQ,EAAE;iBACV,QAAQ,CAAC,gEAAgE,CAAC;YAC7E,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC;YAChF,OAAO,EAAE,CAAC;iBACP,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,8DAA8D,CAAC;YAC3E,OAAO,EAAE,CAAC;iBACP,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,wEAAwE,CAAC;YACrF,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;YACpF,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;YACrF,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;YAChF,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC;YACxE,wBAAwB,EAAE,CAAC;iBACxB,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CAAC,gCAAgC,CAAC;YAC7C,cAAc,EAAE,CAAC;iBACd,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,mEAAmE,CAAC;SACjF,CAAC;aACD,MAAM,EAAE;QACX,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YAC9B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,CAAU,gBAAgB,EAAE,IAAI,CAAC,CAAC;YAChE,OAAO,SAAS,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;KACF;IAED;QACE,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EACT,8LAA8L;QAChM,WAAW,EAAE,CAAC;aACX,MAAM,CAAC;YACN,YAAY,EAAE,CAAC;iBACZ,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,GAAG,CAAC,CAAC,CAAC;iBACN,GAAG,CAAC,EAAE,CAAC;iBACP,QAAQ,CAAC,wCAAwC,CAAC;SACtD,CAAC;aACD,MAAM,EAAE;QACX,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;YAC9B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAU,gBAAgB,EAAE;gBAC1D,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC;aAChC,CAAC,CAAC;YACH,OAAO,SAAS,CAAC,2BAA2B,EAAE,IAAI,CAAC,CAAC;QACtD,CAAC;KACF;CACF,CAAC"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IAEpB,WAAW,EAAE,GAAG,CAAC;IAEjB,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAClF"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
// GoSweetSpot Freight API responses are loosely-typed JSON documents whose exact shapes
|
|
2
|
+
// vary by carrier and account. The tools render results generically (see format.ts), so
|
|
3
|
+
// this module keeps only the plumbing contract.
|
|
4
|
+
export {};
|
|
5
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,wFAAwF;AACxF,wFAAwF;AACxF,gDAAgD"}
|
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@teamnetwork-nz/gosweetspot-mcp-server",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "MCP server for the GoSweetSpot (GSS) Freight API — NZ freight rating, shipment creation, customer orders, manifesting, labels & tracking, with a read-only gate",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"bin": {
|
|
8
|
+
"gosweetspot-mcp-server": "dist/index.js"
|
|
9
|
+
},
|
|
10
|
+
"scripts": {
|
|
11
|
+
"build": "tsc",
|
|
12
|
+
"dev": "tsx src/index.ts",
|
|
13
|
+
"prepublishOnly": "npm run build"
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist"
|
|
17
|
+
],
|
|
18
|
+
"keywords": [
|
|
19
|
+
"mcp",
|
|
20
|
+
"gosweetspot",
|
|
21
|
+
"gss",
|
|
22
|
+
"freight",
|
|
23
|
+
"shipping",
|
|
24
|
+
"courier",
|
|
25
|
+
"model-context-protocol"
|
|
26
|
+
],
|
|
27
|
+
"license": "MIT",
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@modelcontextprotocol/sdk": "^1.10.0",
|
|
30
|
+
"axios": "^1.7.0",
|
|
31
|
+
"zod": "^3.23.0",
|
|
32
|
+
"zod-to-json-schema": "^3.25.2"
|
|
33
|
+
},
|
|
34
|
+
"devDependencies": {
|
|
35
|
+
"@types/node": "^20.0.0",
|
|
36
|
+
"tsx": "^4.15.0",
|
|
37
|
+
"typescript": "^5.5.0"
|
|
38
|
+
},
|
|
39
|
+
"engines": {
|
|
40
|
+
"node": ">=20.0.0"
|
|
41
|
+
}
|
|
42
|
+
}
|