diff --git a/README.md b/README.md index 838ea279b..e81334b50 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ # MCP TypeScript SDK -> [!IMPORTANT] **This is the `main` branch which contains v2 of the SDK (currently in development, pre-alpha).** + +> [!IMPORTANT] +> **This is the `main` branch which contains v2 of the SDK (currently in development, pre-alpha).** > > 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. > > 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/). -![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) +[![NPM Version - Server](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fserver?label=%40modelcontextprotocol%2Fserver)](https://www.npmjs.com/package/@modelcontextprotocol/server) +[![NPM Version - Client](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fclient?label=%40modelcontextprotocol%2Fclient)](https://www.npmjs.com/package/@modelcontextprotocol/client) ![MIT licensed](https://img.shields.io/npm/l/%40modelcontextprotocol%2Fserver)
Table of Contents @@ -102,19 +105,19 @@ import * as z from 'zod/v4'; const server = new McpServer({ name: 'greeting-server', version: '1.0.0' }); server.registerTool( - 'greet', - { - description: 'Greet someone by name', - inputSchema: z.object({ name: z.string() }), - }, - async ({ name }) => ({ - content: [{ type: 'text', text: `Hello, ${name}!` }], - }), + 'greet', + { + description: 'Greet someone by name', + inputSchema: z.object({ name: z.string() }) + }, + async ({ name }) => ({ + content: [{ type: 'text', text: `Hello, ${name}!` }] + }) ); async function main() { - const transport = new StdioServerTransport(); - await server.connect(transport); + const transport = new StdioServerTransport(); + await server.connect(transport); } main(); @@ -125,7 +128,8 @@ Ready to build something real? Follow the step-by-step quickstart tutorials: - [Build a weather server](docs/server-quickstart.md) — server quickstart - [Build an LLM-powered chatbot](docs/client-quickstart.md) — client quickstart -The complete code for each tutorial is in [`examples/server-quickstart/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/examples/server-quickstart/) and [`examples/client-quickstart/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/examples/client-quickstart/). For more advanced runnable examples, see: +The complete code for each tutorial is in [`examples/server-quickstart/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/examples/server-quickstart/) and +[`examples/client-quickstart/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/examples/client-quickstart/). For more advanced runnable examples, see: - [`examples/server/README.md`](examples/server/README.md) — server examples index - [`examples/client/README.md`](examples/client/README.md) — client examples index diff --git a/packages/client/README.md b/packages/client/README.md index 33ba09c2e..589f56635 100644 --- a/packages/client/README.md +++ b/packages/client/README.md @@ -2,9 +2,13 @@ The MCP (Model Context Protocol) TypeScript client SDK. Build MCP clients that connect to MCP servers. -> [!WARNING] **This is an alpha release.** Expect breaking changes until v2 stabilizes. We're publishing early to gather feedback — please try it and open issues — but we can't guarantee API stability yet. We'll aim to minimize disruption between alphas. + +> [!WARNING] +> **This is an alpha release.** Expect breaking changes until v2 stabilizes. We're publishing early to gather feedback — please try it and open issues — but we can't guarantee API stability yet. We'll aim to minimize disruption between alphas. -> [!NOTE] This is **v2** of the MCP TypeScript SDK. It replaces the monolithic `@modelcontextprotocol/sdk` package from v1. See the **[migration guide](https://github.com/modelcontextprotocol/typescript-sdk/blob/main/docs/migration.md)** if you're coming from v1. + +> [!NOTE] +> This is **v2** of the MCP TypeScript SDK. It replaces the monolithic `@modelcontextprotocol/sdk` package from v1. See the **[migration guide](https://github.com/modelcontextprotocol/typescript-sdk/blob/main/docs/migration.md)** if you're coming from v1. ## Install diff --git a/packages/server/README.md b/packages/server/README.md index 6ad42bc03..6f9ccf866 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -2,9 +2,13 @@ The MCP (Model Context Protocol) TypeScript server SDK. Build MCP servers that expose tools, resources, and prompts. -> [!WARNING] **This is an alpha release.** Expect breaking changes until v2 stabilizes. We're publishing early to gather feedback — please try it and open issues — but we can't guarantee API stability yet. We'll aim to minimize disruption between alphas. + +> [!WARNING] +> **This is an alpha release.** Expect breaking changes until v2 stabilizes. We're publishing early to gather feedback — please try it and open issues — but we can't guarantee API stability yet. We'll aim to minimize disruption between alphas. -> [!NOTE] This is **v2** of the MCP TypeScript SDK. It replaces the monolithic `@modelcontextprotocol/sdk` package from v1. See the **[migration guide](https://github.com/modelcontextprotocol/typescript-sdk/blob/main/docs/migration.md)** if you're coming from v1. + +> [!NOTE] +> This is **v2** of the MCP TypeScript SDK. It replaces the monolithic `@modelcontextprotocol/sdk` package from v1. See the **[migration guide](https://github.com/modelcontextprotocol/typescript-sdk/blob/main/docs/migration.md)** if you're coming from v1. ## Install