Skip to content

Commit 16b0fb8

Browse files
authored
fix: update doc links to custom domain and add project documents (modelcontextprotocol#1589)
1 parent 137cf7c commit 16b0fb8

File tree

6 files changed

+16
-17
lines changed

6 files changed

+16
-17
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
>
55
> We anticipate a stable v2 release in Q1 2026. Until then, **v1.x remains the recommended version** for production use. v1.x will continue to receive bug fixes and security updates for at least 6 months after v2 ships to give people time to upgrade.
66
>
7-
> For v1 documentation, see the [V1 API docs](https://modelcontextprotocol.github.io/typescript-sdk/). For v2 API docs, see [`/v2/`](https://modelcontextprotocol.github.io/typescript-sdk/v2/).
7+
> For v1 documentation, see the [V1 API docs](https://ts.sdk.modelcontextprotocol.io/). For v2 API docs, see [`/v2/`](https://ts.sdk.modelcontextprotocol.io/v2/).
88
99
![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fserver) ![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fclient) ![MIT licensed](https://img.shields.io/npm/l/%40modelcontextprotocol%2Fserver)
1010

@@ -131,7 +131,7 @@ Next steps:
131131
- [docs/client.md](docs/client.md) – building MCP clients: connecting, tools, resources, prompts, server-initiated requests, and error handling
132132
- [docs/faq.md](docs/faq.md) – frequently asked questions and troubleshooting
133133
- External references:
134-
- [SDK API documentation](https://modelcontextprotocol.github.io/typescript-sdk/)
134+
- [SDK API documentation](https://ts.sdk.modelcontextprotocol.io/)
135135
- [Model Context Protocol documentation](https://modelcontextprotocol.io)
136136
- [MCP Specification](https://spec.modelcontextprotocol.io)
137137
- [Example Servers](https://github.com/modelcontextprotocol/servers)
@@ -149,7 +149,7 @@ The `docs:multi` script checks out both the `v1.x` and `main` branches via git w
149149

150150
## v1 (legacy) documentation and fixes
151151

152-
If you are using the **v1** generation of the SDK, the **v1 API documentation** is available at [`https://modelcontextprotocol.github.io/typescript-sdk/`](https://modelcontextprotocol.github.io/typescript-sdk/). The v1 source code and any v1-specific fixes live on the long-lived [`v1.x` branch](https://github.com/modelcontextprotocol/typescript-sdk/tree/v1.x). V2 API docs are at [`/v2/`](https://modelcontextprotocol.github.io/typescript-sdk/v2/).
152+
If you are using the **v1** generation of the SDK, the **v1 API documentation** is available at [`https://ts.sdk.modelcontextprotocol.io/`](https://ts.sdk.modelcontextprotocol.io/). The v1 source code and any v1-specific fixes live on the long-lived [`v1.x` branch](https://github.com/modelcontextprotocol/typescript-sdk/tree/v1.x). V2 API docs are at [`/v2/`](https://ts.sdk.modelcontextprotocol.io/v2/).
153153

154154
## Contributing
155155

docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ wanting to switch to `v2` and using SSE should migrate to Streamable HTTP.
8282

8383
### Where do v1 documentation and v1-specific fixes live?
8484

85-
The v1 API documentation is available at [`https://modelcontextprotocol.github.io/typescript-sdk/`](https://modelcontextprotocol.github.io/typescript-sdk/). The v1 source code and any v1-specific fixes live on the long-lived [`v1.x` branch](https://github.com/modelcontextprotocol/typescript-sdk/tree/v1.x). V2 API docs are at [`/v2/`](https://modelcontextprotocol.github.io/typescript-sdk/v2/).
85+
The v1 API documentation is available at [`https://ts.sdk.modelcontextprotocol.io/`](https://ts.sdk.modelcontextprotocol.io/). The v1 source code and any v1-specific fixes live on the long-lived [`v1.x` branch](https://github.com/modelcontextprotocol/typescript-sdk/tree/v1.x). V2 API docs are at [`/v2/`](https://ts.sdk.modelcontextprotocol.io/v2/).

docs/v2-banner.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
document.addEventListener("DOMContentLoaded", function () {
22
var banner = document.createElement("div");
33
banner.innerHTML =
4-
"This documents a <strong>pre-release</strong> version of the SDK. Expect breaking changes. For the stable SDK, see the <a href='/typescript-sdk/'>V1 docs</a>.";
4+
"This documents a <strong>pre-release</strong> version of the SDK. Expect breaking changes. For the stable SDK, see the <a href='/'>V1 docs</a>.";
55
banner.style.cssText =
66
"background:#fff3cd;color:#856404;border-bottom:1px solid #ffc107;padding:8px 16px;text-align:center;font-size:14px;";
77
banner.querySelector("a").style.cssText = "color:#856404;text-decoration:underline;";

examples/server/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ pnpm tsx src/simpleStreamableHttp.ts
3131
| Streamable HTTP server (stateless) | No session tracking; good for simple API-style servers. | [`src/simpleStatelessStreamableHttp.ts`](src/simpleStatelessStreamableHttp.ts) |
3232
| JSON response mode (no SSE) | Streamable HTTP with JSON-only responses and limited notifications. | [`src/jsonResponseStreamableHttp.ts`](src/jsonResponseStreamableHttp.ts) |
3333
| Server notifications over Streamable HTTP | Demonstrates server-initiated notifications via GET+SSE. | [`src/standaloneSseWithGetStreamableHttp.ts`](src/standaloneSseWithGetStreamableHttp.ts) |
34-
| Deprecated HTTP+SSE server (legacy) | Legacy HTTP+SSE transport for backwards-compatibility testing. | [`src/simpleSseServer.ts`](src/simpleSseServer.ts) |
35-
| Backwards-compatible server (Streamable HTTP + SSE) | One server that supports both Streamable HTTP and legacy SSE clients. | [`src/sseAndStreamableHttpCompatibleServer.ts`](src/sseAndStreamableHttpCompatibleServer.ts) |
34+
| Output schema server | Demonstrates tool output validation with structured output schemas. | [`src/mcpServerOutputSchema.ts`](src/mcpServerOutputSchema.ts) |
3635
| Form elicitation server | Collects **non-sensitive** user input via schema-driven forms. | [`src/elicitationFormExample.ts`](src/elicitationFormExample.ts) |
3736
| URL elicitation server | Secure browser-based flows for **sensitive** input (API keys, OAuth, payments). | [`src/elicitationUrlExample.ts`](src/elicitationUrlExample.ts) |
3837
| Sampling + tasks server | Demonstrates sampling and experimental task-based execution. | [`src/toolWithSampleServer.ts`](src/toolWithSampleServer.ts) |
@@ -161,12 +160,10 @@ For scenarios where local in-memory state must be maintained on specific nodes,
161160

162161
## Backwards compatibility (Streamable HTTP ↔ legacy SSE)
163162

164-
Start one of the servers:
163+
Start the server:
165164

166165
```bash
167-
pnpm --filter @modelcontextprotocol/examples-server exec tsx src/simpleSseServer.ts
168166
pnpm --filter @modelcontextprotocol/examples-server exec tsx src/simpleStreamableHttp.ts
169-
pnpm --filter @modelcontextprotocol/examples-server exec tsx src/sseAndStreamableHttpCompatibleServer.ts
170167
```
171168

172169
Then run the backwards-compatible client:

scripts/generate-multidoc.sh

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
# V1 docs (from the v1.x branch) are placed at the root.
66
# V2 docs (from main) are placed under /v2/.
77
#
8-
# This script can be run from any branch — it fetches both v1.x and main
9-
# via git worktrees.
10-
#
118
# Usage:
129
# scripts/generate-multidoc.sh [output-dir]
1310
#
@@ -76,7 +73,7 @@ cat > typedoc.json << 'TYPEDOC_EOF'
7673
"docs/faq.md"
7774
],
7875
"navigationLinks": {
79-
"V2 Docs": "/typescript-sdk/v2/"
76+
"V2 Docs": "/v2/"
8077
},
8178
"headings": {
8279
"readme": false

typedoc.config.mjs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,15 @@ export default {
3232
exclude: ['**/*.examples.ts']
3333
},
3434
highlightLanguages: [...OptionDefaults.highlightLanguages, 'powershell'],
35-
projectDocuments: ['docs/documents.md'],
36-
hostedBaseUrl: 'https://modelcontextprotocol.github.io/typescript-sdk/v2/',
35+
projectDocuments: [
36+
'docs/documents.md',
37+
'packages/middleware/README.md',
38+
'examples/server/README.md',
39+
'examples/client/README.md',
40+
],
41+
hostedBaseUrl: 'https://ts.sdk.modelcontextprotocol.io/v2/',
3742
navigationLinks: {
38-
'V1 Docs': '/typescript-sdk/'
43+
'V1 Docs': '/'
3944
},
4045
navigation: {
4146
compactFolders: true,

0 commit comments

Comments
 (0)