Skip to content

Commit 44f9587

Browse files
authored
docs: fix copy-paste path in publishing quickstart (modelcontextprotocol#1665)
Fixes modelcontextprotocol#1654 Four small fixes to `docs/modelcontextprotocol-io/quickstart.mdx` so the tutorial works when pasted top to bottom: - Clone `quickstart-resources` over HTTPS instead of SSH. The tutorial only asks for a GitHub account, not an SSH key. - Drop the second `cd weather-server-typescript` in Step 2. The prerequisites block already ends in that directory, so running it again fails. - Label the Homebrew tab in Step 3's `CodeGroup`. - Show `1.0.1` in the Step 4 `mcp-publisher init` sample output, and remove the version bump from the edit diff that follows. Since modelcontextprotocol#1145, `init` copies `version` from `package.json`, which the tutorial has already set to `1.0.1`. To check the last item, I built `mcp-publisher` from `main` and ran `init` next to the tutorial's `package.json`. The `server.json` it wrote matches the new sample exactly. @Srinivasan-78 offered to send a PR for the other items; happy to close this if you'd rather do it. I used Claude Code to write this change and the PR description.
1 parent d15cc95 commit 44f9587

1 file changed

Lines changed: 6 additions & 11 deletions

File tree

‎docs/modelcontextprotocol-io/quickstart.mdx‎

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This tutorial will show you how to publish an MCP server written in TypeScript t
2222
If you do not have an MCP server written in TypeScript, you can copy the `weather-server-typescript` server from the [`modelcontextprotocol/quickstart-resources` repository](https://github.com/modelcontextprotocol/quickstart-resources) to follow along with this tutorial:
2323

2424
```bash
25-
git clone --depth 1 git@github.com:modelcontextprotocol/quickstart-resources.git
25+
git clone --depth 1 https://github.com/modelcontextprotocol/quickstart-resources.git
2626
cp -r quickstart-resources/weather-server-typescript .
2727
rm -rf quickstart-resources
2828
cd weather-server-typescript
@@ -73,9 +73,6 @@ The MCP Registry only hosts metadata, not artifacts, so we must publish the pack
7373
Ensure the distribution files are built:
7474

7575
```bash
76-
# Navigate to project directory
77-
cd weather-server-typescript
78-
7976
# Install dependencies
8077
npm install
8178

@@ -110,7 +107,7 @@ $arch = if ([System.Runtime.InteropServices.RuntimeInformation]::ProcessArchitec
110107
# Move mcp-publisher.exe to a directory in your PATH
111108
```
112109

113-
```bash
110+
```bash Homebrew
114111
brew install mcp-publisher
115112
```
116113

@@ -162,12 +159,12 @@ Open the generated `server.json` file, and you should see contents like:
162159
"url": "https://github.com/my-username/mcp-weather-server",
163160
"source": "github"
164161
},
165-
"version": "1.0.0",
162+
"version": "1.0.1",
166163
"packages": [
167164
{
168165
"registryType": "npm",
169166
"identifier": "@my-username/mcp-weather-server",
170-
"version": "1.0.0",
167+
"version": "1.0.1",
171168
"transport": {
172169
"type": "stdio"
173170
},
@@ -196,14 +193,12 @@ Edit the contents as necessary:
196193
"url": "https://github.com/my-username/mcp-weather-server",
197194
"source": "github"
198195
},
199-
- "version": "1.0.0",
200-
+ "version": "1.0.1",
196+
"version": "1.0.1",
201197
"packages": [
202198
{
203199
"registryType": "npm",
204200
"identifier": "@my-username/mcp-weather-server",
205-
- "version": "1.0.0",
206-
+ "version": "1.0.1",
201+
"version": "1.0.1",
207202
"transport": {
208203
"type": "stdio"
209204
- },

0 commit comments

Comments
 (0)