Skip to content

Commit 5fc42e9

Browse files
fix README.md badges and blockquote icon (#2022)
Co-authored-by: Matt <77928207+mattzcarey@users.noreply.github.com>
1 parent 48251fe commit 5fc42e9

3 files changed

Lines changed: 29 additions & 17 deletions

File tree

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# MCP TypeScript SDK
22

3-
> [!IMPORTANT] **This is the `main` branch which contains v2 of the SDK (currently in development, pre-alpha).**
3+
<!-- prettier-ignore -->
4+
> [!IMPORTANT]
5+
> **This is the `main` branch which contains v2 of the SDK (currently in development, pre-alpha).**
46
>
57
> 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.
68
>
79
> 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/).
810
9-
![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)
11+
[![NPM Version - Server](https://img.shields.io/npm/v/%40modelcontextprotocol%2Fserver?label=%40modelcontextprotocol%2Fserver)](https://www.npmjs.com/package/@modelcontextprotocol/server)
12+
[![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)
1013

1114
<details>
1215
<summary>Table of Contents</summary>
@@ -102,19 +105,19 @@ import * as z from 'zod/v4';
102105
const server = new McpServer({ name: 'greeting-server', version: '1.0.0' });
103106

104107
server.registerTool(
105-
'greet',
106-
{
107-
description: 'Greet someone by name',
108-
inputSchema: z.object({ name: z.string() }),
109-
},
110-
async ({ name }) => ({
111-
content: [{ type: 'text', text: `Hello, ${name}!` }],
112-
}),
108+
'greet',
109+
{
110+
description: 'Greet someone by name',
111+
inputSchema: z.object({ name: z.string() })
112+
},
113+
async ({ name }) => ({
114+
content: [{ type: 'text', text: `Hello, ${name}!` }]
115+
})
113116
);
114117

115118
async function main() {
116-
const transport = new StdioServerTransport();
117-
await server.connect(transport);
119+
const transport = new StdioServerTransport();
120+
await server.connect(transport);
118121
}
119122

120123
main();
@@ -125,7 +128,8 @@ Ready to build something real? Follow the step-by-step quickstart tutorials:
125128
- [Build a weather server](docs/server-quickstart.md) — server quickstart
126129
- [Build an LLM-powered chatbot](docs/client-quickstart.md) — client quickstart
127130

128-
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:
131+
The complete code for each tutorial is in [`examples/server-quickstart/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/examples/server-quickstart/) and
132+
[`examples/client-quickstart/`](https://github.com/modelcontextprotocol/typescript-sdk/tree/main/examples/client-quickstart/). For more advanced runnable examples, see:
129133

130134
- [`examples/server/README.md`](examples/server/README.md) — server examples index
131135
- [`examples/client/README.md`](examples/client/README.md) — client examples index

packages/client/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22

33
The MCP (Model Context Protocol) TypeScript client SDK. Build MCP clients that connect to MCP servers.
44

5-
> [!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.
5+
<!-- prettier-ignore -->
6+
> [!WARNING]
7+
> **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.
68
7-
> [!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.
9+
<!-- prettier-ignore -->
10+
> [!NOTE]
11+
> 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.
812
913
## Install
1014

packages/server/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,13 @@
22

33
The MCP (Model Context Protocol) TypeScript server SDK. Build MCP servers that expose tools, resources, and prompts.
44

5-
> [!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.
5+
<!-- prettier-ignore -->
6+
> [!WARNING]
7+
> **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.
68
7-
> [!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.
9+
<!-- prettier-ignore -->
10+
> [!NOTE]
11+
> 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.
812
913
## Install
1014

0 commit comments

Comments
 (0)