Add @deprecated annotations to legacy APIs (modelcontextprotocol#1018)

Co-authored-by: Claude <[email protected]>

Author: 2 people

src/client/sse.ts

@@ -57,6 +57,7 @@ export type SSEClientTransportOptions = {
 /**
  * Client transport for SSE: this will connect to a server using Server-Sent Events for receiving
  * messages and make separate POST requests for sending messages.
+ * @deprecated SSEClientTransport is deprecated. Prefer to use StreamableHTTPClientTransport where possible instead. Note that because some servers are still using SSE, clients may need to support both transports during the migration period.
  */
 export class SSEClientTransport implements Transport {
     private _eventSource?: EventSource;

src/server/index.ts

@@ -101,6 +101,7 @@ export type ServerOptions = ProtocolOptions & {
  *   version: "1.0.0"
  * })
  * ```
+ * @deprecated Use `McpServer` instead for the high-level API. Only use `Server` for advanced use cases.
  */
 export class Server<
     RequestT extends Request = Request,

src/server/mcp.ts

@@ -446,21 +446,25 @@ export class McpServer {
 
     /**
      * Registers a resource `name` at a fixed URI, which will use the given callback to respond to read requests.
+     * @deprecated Use `registerResource` instead.
      */
     resource(name: string, uri: string, readCallback: ReadResourceCallback): RegisteredResource;
 
     /**
      * Registers a resource `name` at a fixed URI with metadata, which will use the given callback to respond to read requests.
+     * @deprecated Use `registerResource` instead.
      */
     resource(name: string, uri: string, metadata: ResourceMetadata, readCallback: ReadResourceCallback): RegisteredResource;
 
     /**
      * Registers a resource `name` with a template pattern, which will use the given callback to respond to read requests.
+     * @deprecated Use `registerResource` instead.
      */
     resource(name: string, template: ResourceTemplate, readCallback: ReadResourceTemplateCallback): RegisteredResourceTemplate;
 
     /**
      * Registers a resource `name` with a template pattern and metadata, which will use the given callback to respond to read requests.
+     * @deprecated Use `registerResource` instead.
      */
     resource(
         name: string,
@@ -718,11 +722,13 @@ export class McpServer {
 
     /**
      * Registers a zero-argument tool `name`, which will run the given function when the client calls it.
+     * @deprecated Use `registerTool` instead.
      */
     tool(name: string, cb: ToolCallback): RegisteredTool;
 
     /**
      * Registers a zero-argument tool `name` (with a description) which will run the given function when the client calls it.
+     * @deprecated Use `registerTool` instead.
      */
     tool(name: string, description: string, cb: ToolCallback): RegisteredTool;
 
@@ -732,6 +738,7 @@ export class McpServer {
      *
      * Note: We use a union type for the second parameter because TypeScript cannot reliably disambiguate
      * between ToolAnnotations and ZodRawShape during overload resolution, as both are plain object types.
+     * @deprecated Use `registerTool` instead.
      */
     tool<Args extends ZodRawShapeCompat>(
         name: string,
@@ -746,6 +753,7 @@ export class McpServer {
      *
      * Note: We use a union type for the third parameter because TypeScript cannot reliably disambiguate
      * between ToolAnnotations and ZodRawShape during overload resolution, as both are plain object types.
+     * @deprecated Use `registerTool` instead.
      */
     tool<Args extends ZodRawShapeCompat>(
         name: string,
@@ -756,6 +764,7 @@ export class McpServer {
 
     /**
      * Registers a tool with both parameter schema and annotations.
+     * @deprecated Use `registerTool` instead.
      */
     tool<Args extends ZodRawShapeCompat>(
         name: string,
@@ -766,6 +775,7 @@ export class McpServer {
 
     /**
      * Registers a tool with description, parameter schema, and annotations.
+     * @deprecated Use `registerTool` instead.
      */
     tool<Args extends ZodRawShapeCompat>(
         name: string,
@@ -858,21 +868,25 @@ export class McpServer {
 
     /**
      * Registers a zero-argument prompt `name`, which will run the given function when the client calls it.
+     * @deprecated Use `registerPrompt` instead.
      */
     prompt(name: string, cb: PromptCallback): RegisteredPrompt;
 
     /**
      * Registers a zero-argument prompt `name` (with a description) which will run the given function when the client calls it.
+     * @deprecated Use `registerPrompt` instead.
      */
     prompt(name: string, description: string, cb: PromptCallback): RegisteredPrompt;
 
     /**
      * Registers a prompt `name` accepting the given arguments, which must be an object containing named properties associated with Zod schemas. When the client calls it, the function will be run with the parsed and validated arguments.
+     * @deprecated Use `registerPrompt` instead.
      */
     prompt<Args extends PromptArgsRawShape>(name: string, argsSchema: Args, cb: PromptCallback<Args>): RegisteredPrompt;
 
     /**
      * Registers a prompt `name` (with a description) accepting the given arguments, which must be an object containing named properties associated with Zod schemas. When the client calls it, the function will be run with the parsed and validated arguments.
+     * @deprecated Use `registerPrompt` instead.
      */
     prompt<Args extends PromptArgsRawShape>(
         name: string,

src/server/sse.ts

@@ -36,6 +36,7 @@ export interface SSEServerTransportOptions {
  * Server transport for SSE: this will send messages over an SSE connection and receive messages from HTTP POST requests.
  *
  * This transport is only available in Node.js environments.
+ * @deprecated SSEServerTransport is deprecated. Use StreamableHTTPServerTransport instead.
  */
 export class SSEServerTransport implements Transport {
     private _sseResponse?: ServerResponse;