@shippo/shippo-mcp 0.5.0 → 0.8.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.
Files changed (2) hide show
  1. package/README.md +16 -13
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -8,7 +8,7 @@ Model Context Protocol (MCP) Server for the Shippo API.
8
8
 
9
9
 
10
10
  You must register for a [Shippo account](https://apps.goshippo.com/join) to use our API. It's free to sign up. Only pay to print a live label — test labels are free.
11
- To use the MCP server, youll need an [API Token](https://docs.goshippo.com/docs/guides_general/authentication/). Replace `<YOUR_SHIPPO_API_KEY>` with your own token in examples.
11
+ To use the MCP server, you'll need an [API Token](https://docs.goshippo.com/docs/guides_general/authentication/). Replace `YOUR_SHIPPO_API_KEY` with your own token (including the `ShippoToken ` prefix) in the examples below.
12
12
 
13
13
  <!-- Start Summary [summary] -->
14
14
  ## Summary
@@ -37,9 +37,9 @@ Shippo MCP Server: Use this MCP Server to integrate with the Shippo service usin
37
37
  <details>
38
38
  <summary>Cursor</summary>
39
39
 
40
- [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=shippo-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBzaGlwcG8vc2hpcHBvLW1jcCIsInN0YXJ0IiwiLS1hcGkta2V5LWhlYWRlciIsIllPVVJfU0hJUFBPX0FQSV9LRVkiLCItLXNoaXBwby1hcGktdmVyc2lvbiIsIjIwMTgtMDItMDgiXX0=)
40
+ [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=shippo-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBzaGlwcG8vc2hpcHBvLW1jcCIsInN0YXJ0IiwiLS1hcGkta2V5LWhlYWRlciIsIlNoaXBwb1Rva2VuIFlPVVJfU0hJUFBPX0FQSV9LRVkiLCItLXNoaXBwby1hcGktdmVyc2lvbiIsIjIwMTgtMDItMDgiXX0=)
41
41
 
42
- > **Tip**: When the installation dialog opens in Cursor, remember to replace `YOUR_SHIPPO_API_KEY` with your actual credential before saving.
42
+ > ⚠️ **Important**: Click **Install** first to add the server, then go to **Settings → Tools & MCP → shippo-mcp (edit)** to edit the configuration. Replace `YOUR_SHIPPO_API_KEY` with your actual API key (keep the `ShippoToken ` prefix), then save `mcp.json`, and toggle shippo-mcp on and off for changes to take effect.
43
43
 
44
44
  Or manually:
45
45
 
@@ -57,7 +57,7 @@ Or manually:
57
57
  "@shippo/shippo-mcp",
58
58
  "start",
59
59
  "--api-key-header",
60
- "YOUR_SHIPPO_API_KEY",
60
+ "ShippoToken YOUR_SHIPPO_API_KEY",
61
61
  "--shippo-api-version",
62
62
  "2018-02-08"
63
63
  ]
@@ -72,7 +72,7 @@ Or manually:
72
72
  <summary>Claude Code CLI</summary>
73
73
 
74
74
  ```bash
75
- claude mcp add @shippo/shippo-mcp npx @shippo-mcp start -- --api-key-header ... --shippo-api-version 2018-02-08
75
+ claude mcp add @shippo/shippo-mcp npx @shippo-mcp start -- --api-key-header "ShippoToken YOUR_SHIPPO_API_KEY" --shippo-api-version 2018-02-08
76
76
  ```
77
77
 
78
78
  </details>
@@ -99,7 +99,7 @@ Paste the following config in the configuration
99
99
  "@shippo/shippo-mcp",
100
100
  "start",
101
101
  "--api-key-header",
102
- "...",
102
+ "ShippoToken YOUR_SHIPPO_API_KEY",
103
103
  "--shippo-api-version",
104
104
  "2018-02-08"
105
105
  ]
@@ -112,16 +112,19 @@ Paste the following config in the configuration
112
112
 
113
113
 
114
114
  <details>
115
- <summary> Stdio installation via npm </summary>
116
- To start the MCP server, run:
115
+ <summary> Manual CLI usage </summary>
116
+
117
+ If you need to start the MCP server manually (e.g., for use with other MCP clients or debugging), run:
117
118
 
118
119
  ```bash
119
- npx @shippo/shippo-mcp start --api-key-header ... --shippo-api-version 2018-02-08
120
+ npx @shippo/shippo-mcp start --api-key-header "ShippoToken YOUR_SHIPPO_API_KEY" --shippo-api-version 2018-02-08
120
121
  ```
121
122
 
123
+ > **Note:** This starts the server in stdio mode, waiting for MCP protocol messages. It won't show an interactive prompt — it's designed to be connected to by an MCP client like Cursor or Claude Desktop.
124
+
122
125
  For a full list of server arguments, run:
123
126
 
124
- ```
127
+ ```bash
125
128
  npx @shippo/shippo-mcp --help
126
129
  ```
127
130
 
@@ -150,7 +153,7 @@ To run the server locally from source (e.g., for development), use the following
150
153
  "/ABSOLUTE/PATH/TO/REPO/bin/mcp-server.js",
151
154
  "start",
152
155
  "--api-key-header",
153
- "YOUR_SHIPPO_API_KEY",
156
+ "ShippoToken YOUR_SHIPPO_API_KEY",
154
157
  "--shippo-api-version",
155
158
  "2018-02-08"
156
159
  ]
@@ -176,7 +179,7 @@ Replace `/ABSOLUTE/PATH/TO/REPO` with the full path to your cloned repository.
176
179
  "@shippo/shippo-mcp",
177
180
  "start",
178
181
  "--api-key-header",
179
- "YOUR_SHIPPO_API_KEY",
182
+ "ShippoToken YOUR_SHIPPO_API_KEY",
180
183
  "--shippo-api-version",
181
184
  "2018-02-08"
182
185
  ]
@@ -188,7 +191,7 @@ Replace `/ABSOLUTE/PATH/TO/REPO` with the full path to your cloned repository.
188
191
  ### Command Line
189
192
 
190
193
  ```bash
191
- npx @shippo/shippo-mcp start --api-key-header YOUR_SHIPPO_API_KEY --shippo-api-version 2018-02-08
194
+ npx @shippo/shippo-mcp start --api-key-header "ShippoToken YOUR_SHIPPO_API_KEY" --shippo-api-version 2018-02-08
192
195
  ```
193
196
 
194
197
  <!-- End Configuration [configuration] -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shippo/shippo-mcp",
3
- "version": "0.5.0",
3
+ "version": "0.8.0",
4
4
  "author": "shippo",
5
5
  "type": "module",
6
6
  "sideEffects": false,