@shippo/shippo-mcp 0.6.0 → 0.8.1
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 +35 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,8 +20,7 @@ Shippo MCP Server: Use this MCP Server to integrate with the Shippo service usin
|
|
|
20
20
|
## Table of Contents
|
|
21
21
|
<!-- $toc-max-depth=2 -->
|
|
22
22
|
* [<img src="https://docs.goshippo.com/images/Logo.png" width="30" alt="Shippo logo"> Shippo MCP Server](#img-srchttpsdocsgoshippocomimageslogopng-width30-altshippo-logo-shippo-mcp-server)
|
|
23
|
-
* [
|
|
24
|
-
* [Development](#development)
|
|
23
|
+
* [Quick Start](#quick-start)
|
|
25
24
|
* [Configuration](#configuration)
|
|
26
25
|
* [Features](#features)
|
|
27
26
|
* [Security](#security)
|
|
@@ -32,7 +31,7 @@ Shippo MCP Server: Use this MCP Server to integrate with the Shippo service usin
|
|
|
32
31
|
<!-- End Table of Contents [toc] -->
|
|
33
32
|
|
|
34
33
|
<!-- Start Installation [installation] -->
|
|
35
|
-
##
|
|
34
|
+
## Quick Start
|
|
36
35
|
|
|
37
36
|
<details>
|
|
38
37
|
<summary>Cursor</summary>
|
|
@@ -112,42 +111,38 @@ Paste the following config in the configuration
|
|
|
112
111
|
|
|
113
112
|
|
|
114
113
|
<details>
|
|
115
|
-
<summary>
|
|
116
|
-
|
|
114
|
+
<summary> Manual CLI usage </summary>
|
|
115
|
+
|
|
116
|
+
If you need to start the MCP server manually (e.g., for use with other MCP clients or debugging), run:
|
|
117
117
|
|
|
118
118
|
```bash
|
|
119
119
|
npx @shippo/shippo-mcp start --api-key-header "ShippoToken YOUR_SHIPPO_API_KEY" --shippo-api-version 2018-02-08
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
+
> **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.
|
|
123
|
+
|
|
122
124
|
For a full list of server arguments, run:
|
|
123
125
|
|
|
124
|
-
```
|
|
126
|
+
```bash
|
|
125
127
|
npx @shippo/shippo-mcp --help
|
|
126
128
|
```
|
|
127
129
|
|
|
128
130
|
</details>
|
|
129
131
|
<!-- End Installation [installation] -->
|
|
130
132
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
To build the server from source:
|
|
134
|
-
|
|
135
|
-
1. Clone the repository
|
|
136
|
-
2. Install dependencies: `npm install`
|
|
137
|
-
3. Build the server: `npm run build`
|
|
138
|
-
4. The server binary will be at `bin/mcp-server.js`
|
|
133
|
+
<!-- Start Configuration [configuration] -->
|
|
139
134
|
|
|
140
|
-
|
|
135
|
+
## Configuration
|
|
141
136
|
|
|
142
|
-
|
|
137
|
+
### Cursor / Claude
|
|
143
138
|
|
|
144
139
|
```json
|
|
145
140
|
{
|
|
146
141
|
"mcpServers": {
|
|
147
|
-
"shippo-
|
|
148
|
-
"command": "
|
|
142
|
+
"shippo-mcp": {
|
|
143
|
+
"command": "npx",
|
|
149
144
|
"args": [
|
|
150
|
-
"/
|
|
145
|
+
"@shippo/shippo-mcp",
|
|
151
146
|
"start",
|
|
152
147
|
"--api-key-header",
|
|
153
148
|
"ShippoToken YOUR_SHIPPO_API_KEY",
|
|
@@ -159,21 +154,33 @@ To run the server locally from source (e.g., for development), use the following
|
|
|
159
154
|
}
|
|
160
155
|
```
|
|
161
156
|
|
|
162
|
-
|
|
157
|
+
### Command Line
|
|
163
158
|
|
|
164
|
-
|
|
159
|
+
```bash
|
|
160
|
+
npx @shippo/shippo-mcp start --api-key-header "ShippoToken YOUR_SHIPPO_API_KEY" --shippo-api-version 2018-02-08
|
|
161
|
+
```
|
|
165
162
|
|
|
166
|
-
|
|
163
|
+
<details>
|
|
164
|
+
<summary>Development</summary>
|
|
167
165
|
|
|
168
|
-
|
|
166
|
+
To build the server from source:
|
|
167
|
+
|
|
168
|
+
1. Clone the repository
|
|
169
|
+
2. Install dependencies: `npm install`
|
|
170
|
+
3. Build the server: `npm run build`
|
|
171
|
+
4. The server binary will be at `bin/mcp-server.js`
|
|
172
|
+
|
|
173
|
+
#### Local Configuration
|
|
174
|
+
|
|
175
|
+
To run the server locally from source (e.g., for development), use the following configuration in Cursor or Claude:
|
|
169
176
|
|
|
170
177
|
```json
|
|
171
178
|
{
|
|
172
179
|
"mcpServers": {
|
|
173
|
-
"shippo-
|
|
174
|
-
"command": "
|
|
180
|
+
"shippo-dev": {
|
|
181
|
+
"command": "node",
|
|
175
182
|
"args": [
|
|
176
|
-
"
|
|
183
|
+
"/ABSOLUTE/PATH/TO/REPO/bin/mcp-server.js",
|
|
177
184
|
"start",
|
|
178
185
|
"--api-key-header",
|
|
179
186
|
"ShippoToken YOUR_SHIPPO_API_KEY",
|
|
@@ -185,11 +192,9 @@ Replace `/ABSOLUTE/PATH/TO/REPO` with the full path to your cloned repository.
|
|
|
185
192
|
}
|
|
186
193
|
```
|
|
187
194
|
|
|
188
|
-
|
|
195
|
+
Replace `/ABSOLUTE/PATH/TO/REPO` with the full path to your cloned repository.
|
|
189
196
|
|
|
190
|
-
|
|
191
|
-
npx @shippo/shippo-mcp start --api-key-header "ShippoToken YOUR_SHIPPO_API_KEY" --shippo-api-version 2018-02-08
|
|
192
|
-
```
|
|
197
|
+
</details>
|
|
193
198
|
|
|
194
199
|
<!-- End Configuration [configuration] -->
|
|
195
200
|
|