typescript-sdk README

The project's README from github.com/modelcontextprotocol/typescript-sdk. As one markdown file: README.md.

MCP TypeScript SDK

[!IMPORTANT] This is the main branch — v2 of the SDK (@modelcontextprotocol/server, @modelcontextprotocol/client), implementing the 2026-07-28 MCP spec.

Have feedback? Please open a v2 issue — it is the most useful thing you can do for the SDK right now. The v2 documentation starts with a ten-minute server tutorial.

v2 is the stable release line, released alongside the 2026-07-28 spec. v1.x continues to receive bug fixes and security updates for at least 6 months after v2's release. v1 documentation: ts.sdk.modelcontextprotocol.io · v2: /v2/.

[!WARNING] We're limiting pull requests to 1 per new contributor while v2 settles after the 2026-07-28 spec release.

Issues are the most useful feedback right now — we'll reopen PRs as v2 stabilizes.

NPM Version - Server NPM Version - Client MIT licensed

Table of Contents

Overview

The Model Context Protocol (MCP) allows applications to provide context for LLMs in a standardized way, separating the concerns of providing context from the actual LLM interaction.

This repository contains the TypeScript SDK implementation of the MCP specification. It runs on Node.js, Bun, and Deno, and ships:

Packages

This monorepo publishes split packages:

Tool and prompt schemas use Standard Schema — bring Zod v4, Valibot, ArkType, or any compatible library.

Middleware packages (optional)

The SDK also publishes small "middleware" packages under packages/middleware/ that help you wire MCP into a specific runtime or web framework.

They are intentionally thin adapters: they should not introduce new MCP functionality or business logic. See packages/middleware/README.md for details.

Installation

Server

npm install @modelcontextprotocol/server
# or
bun add @modelcontextprotocol/server
# or
deno add npm:@modelcontextprotocol/server

Client

npm install @modelcontextprotocol/client
# or
bun add @modelcontextprotocol/client
# or
deno add npm:@modelcontextprotocol/client

Optional middleware packages

The SDK also publishes optional “middleware” packages that help you wire MCP into a specific runtime or web framework (for example Express, Fastify, Hono, or Node.js http).

These packages are intentionally thin adapters and should not introduce additional MCP features or business logic. See packages/middleware/README.md for details.

# Node.js HTTP (IncomingMessage/ServerResponse) Streamable HTTP transport:
npm install @modelcontextprotocol/node

# Express integration:
npm install @modelcontextprotocol/express express

# Fastify integration:
npm install @modelcontextprotocol/fastify fastify

# Hono integration:
npm install @modelcontextprotocol/hono hono

Getting Started

Here is what an MCP server looks like. This minimal example exposes a single greet tool over stdio:

import { McpServer } from '@modelcontextprotocol/server';
import { StdioServerTransport } from '@modelcontextprotocol/server/stdio';
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}!` }]
    })
);

async function main() {
    const transport = new StdioServerTransport();
    await server.connect(transport);
}

main();

Ready to build something real? Follow the step-by-step tutorials:

For runnable, end-to-end examples beyond the tutorials, see:

Documentation

Building docs locally

To work on the documentation site locally:

pnpm docs:api      # Generate the API reference markdown (output: docs/api/)
pnpm docs:dev      # Start the VitePress dev server for the V2 site
pnpm docs:build    # Build the V2 site (output: docs/.vitepress/dist/)
pnpm docs:multi    # Build the combined V1 + V2 site (output: tmp/docs-combined/)

The docs:multi script builds the V2 site from the current checkout, checks out the v1.x branch via a git worktree to build the V1 site, and produces a combined site with V1 docs at the root and V2 docs under /v2/.

v1 (legacy) documentation and fixes

If you are using the v1 generation of the SDK, the v1 API documentation is available at https://ts.sdk.modelcontextprotocol.io/. The v1 source code and any v1-specific fixes live on the long-lived v1.x branch. V2 API docs are at /v2/.

Contributing

Issues and pull requests are welcome on GitHub at https://github.com/modelcontextprotocol/typescript-sdk.

License

This project is licensed under the Apache License 2.0 for new contributions, with existing code under MIT. See the LICENSE file for details.

typescript-sdk (modelcontextprotocol/typescript-sdk)

Searching Database…

13.6K ·GitHub
Typescript-sdk
Что это такое?Это официальный SDK на TypeScript для Model Context Protocol (MCP), который позволяет приложениям передавать LLM стандартизированный контекст, создавая MCP-серверы и клиенты.
Это один SDK или он разделён на отдельные пакеты?Это монорепозиторий, который публикует отдельные пакеты @modelcontextprotocol/server и @modelcontextprotocol/client, а также необязательные тонкие адаптеры промежуточного ПО для Express, Fastify, Hono и модуля http из Node.
Как с его помощью создать первый MCP-сервер?Следуйте официальному пошаговому руководству: установите серверный пакет и разверните минимальный пример, например один инструмент greet, работающий через stdio, примерно за десять минут.
Какие среды выполнения JavaScript он поддерживает?Он работает на Node.js, Bun и Deno. Если вы выберете Node, package.json требует Node >=20, и никаких других зависимостей от среды выполнения нет.
Можно ли уже сейчас начать использовать v2?v2 — новая стабильная версия, соответствующая спецификации от 2026-07-28, но она ещё дорабатывается: сопровождающие сейчас ограничивают внешние пул-реквесты одним на каждого нового участника и предпочитают обратную связь через issue. Версия v1.x продолжает получать исправления багов и уязвимостей не менее шести месяцев после выхода v2.
Какие транспорты поддерживает SDK для связи по MCP?Встроены оба транспорта, stdio и Streamable HTTP, а также вспомогательные средства OAuth для защиты соединений между клиентом и сервером.
Добавляют ли пакеты промежуточного ПО, такие как Express или Hono, дополнительные возможности MCP?Нет. Это намеренно тонкие адаптеры, которые занимаются такими задачами, как проверка заголовка Host и разбор тела запроса, и не должны добавлять новую функциональность MCP или бизнес-логику.
Могу ли я использовать любую библиотеку схем для инструментов и промптов?Да, схемы работают через интерфейс Standard Schema, поэтому подойдут Zod v4, Valibot, ArkType или любая совместимая библиотека. Вы не привязаны к одному валидатору.
Где найти готовые к запуску примеры помимо руководств?В каталоге examples/ лежат пары примеров клиент/сервер с самопроверкой, по одному сценарию в каталоге. Описание есть в examples/README.md.
What are similar projects?executor, http-proxy-middleware, mcp-use, mcporter, TetreesAgent_EX, trueforge, python-sdk, excalidraw-mcp
Which topics is it in?fastify, hono, mcp-client, express, oauth, monorepo, model-context-protocol, sdk, mcp-server, mcp, npm, apache-2.0
Creator
modelcontextprotocol
Size
19.8 MB
Stars
13.6K
Updated
CommitOct 13Releasev2.3.1Oct 05
Age
2y
Commits · 90 Days