Skip to content

Commit 10164d3

Browse files
docs: fix self-contradictory 'removed' wording in 3 spots (variadic methods, StreamableHTTPError, SKILL §5 rows)
1 parent 93ce57c commit 10164d3

2 files changed

Lines changed: 7 additions & 8 deletions

File tree

docs/migration-SKILL.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ The v1 names below are still exported as `@deprecated` aliases. Migrate to the v
100100
| `ResourceReference` | `ResourceTemplateReference` |
101101
| `ResourceReferenceSchema` | `ResourceTemplateReferenceSchema` |
102102
| `ResourceTemplate` (the protocol _type_) | `ResourceTemplateType` (`ResourceTemplate` is now the server template _class_) |
103-
| `IsomorphicHeaders` | REMOVED (use Web Standard `Headers`) |
104-
| `RequestInfo` (custom SDK type) | REMOVED (use Web Standard `Request` via `ctx.http?.req`) |
103+
| `IsomorphicHeaders` | `Headers` (Web Standard) |
104+
| `RequestInfo` (custom SDK type) | `Request` (Web Standard, via `ctx.http?.req`) |
105105
| `ZodRawShapeCompat` | `StandardSchemaWithJSON` |
106106
| `AuthInfo` (from `server/auth/types.js`) | `AuthInfo` (now re-exported by `@modelcontextprotocol/client` and `@modelcontextprotocol/server`) |
107107
| `OAuthProtectedResourceMetadata` (from `shared/auth.js`) | `OAuthProtectedResourceMetadata` (re-exported by `@modelcontextprotocol/client` / `server`) |
@@ -112,8 +112,9 @@ The v1 names below are still exported as `@deprecated` aliases. Migrate to the v
112112
| `ErrorCode` | `ProtocolErrorCode` |
113113
| `ErrorCode.RequestTimeout` | `SdkErrorCode.RequestTimeout` |
114114
| `ErrorCode.ConnectionClosed` | `SdkErrorCode.ConnectionClosed` |
115-
| `StreamableHTTPError` | REMOVED (use `SdkError` with `SdkErrorCode.ClientHttp*`) |
116-
| `WebSocketClientTransport` | REMOVED (use `StreamableHTTPClientTransport` or `StdioClientTransport`) |
115+
| `StreamableHTTPError` | `SdkError` with `SdkErrorCode.ClientHttp*` |
116+
117+
`WebSocketClientTransport` is **removed** (no deprecated alias). Use `StreamableHTTPClientTransport` or `StdioClientTransport`.
117118

118119
All other **type** symbols from `@modelcontextprotocol/sdk/types.js` retain their original names. **Zod schemas** (e.g., `CallToolResultSchema`, `ListToolsResultSchema`, `OAuthTokensSchema`) are no longer part of the public API. For runtime validation: use
119120
`parseJSONRPCMessage(raw)` for transport framing, `isCallToolResult(v)` for the common case, or `specTypeSchema('<Name>')` / `isSpecType('<Name>', v)` for any other spec type. The raw Zod constants remain available at `@modelcontextprotocol/server/zod-schemas` as a compatibility

docs/migration.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -292,9 +292,7 @@ const debug = url.searchParams.get('debug');
292292

293293
### `McpServer.tool()`, `.prompt()`, `.resource()` deprecated
294294

295-
These variadic methods are still available as `@deprecated` overloads that forward to `registerTool`/`registerPrompt`/`registerResource`. Migrate when convenient:
296-
297-
The deprecated variadic-overload methods have been removed. Use `registerTool`, `registerPrompt`, and `registerResource` instead. These use an explicit config object rather than positional arguments.
295+
These variadic methods are still available as `@deprecated` overloads that forward to `registerTool`/`registerPrompt`/`registerResource`. The new methods use an explicit config object rather than positional arguments. Migrate when convenient:
298296

299297
**Before (v1):**
300298

@@ -854,7 +852,7 @@ The new `SdkErrorCode` enum contains string-valued codes for local SDK errors:
854852
| `SdkErrorCode.ClientHttpFailedToOpenStream` | Failed to open SSE stream |
855853
| `SdkErrorCode.ClientHttpFailedToTerminateSession` | Failed to terminate session |
856854

857-
#### `StreamableHTTPError` removed
855+
#### `StreamableHTTPError` deprecated
858856

859857
`StreamableHTTPError` is now a subclass of `SdkError` (so `instanceof SdkError` and `instanceof StreamableHTTPError` both work). HTTP transport errors carry specific `SdkErrorCode` values for granular handling. Note: `error.code` is now an `SdkErrorCode` string; the HTTP status is on `error.status`.
860858

0 commit comments

Comments
 (0)