Skip to content

Commit 5b79322

Browse files
committed
merge commit
2 parents 564aed2 + f82c997 commit 5b79322

File tree

9 files changed

+149
-92
lines changed

9 files changed

+149
-92
lines changed

.changeset/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://unpkg.com/@changesets/config@3.1.2/schema.json",
3-
"changelog": ["@changesets/changelog-github", { "repo": "@modelcontextprotocol/typescript-sdk" }],
3+
"changelog": ["@changesets/changelog-github", { "repo": "modelcontextprotocol/typescript-sdk" }],
44
"commit": false,
55
"fixed": [],
66
"linked": [],

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ jobs:
4040
with:
4141
publish: pnpm run build:all && pnpm changeset publish
4242
env:
43-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
43+
GITHUB_TOKEN: ${{ github.token }}
4444
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
4545
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CONTRIBUTING.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,40 @@
22

33
We welcome contributions to the Model Context Protocol TypeScript SDK! This document outlines the process for contributing to the project.
44

5+
## Branches
6+
7+
This repository has two main branches:
8+
9+
- **`main`** – v2 of the SDK (currently in development). This is a monorepo with split packages.
10+
- **`v1.x`** – stable v1 release. Bug fixes and patches for v1 should target this branch.
11+
12+
**Which branch should I use as a base?**
13+
14+
- For **new features** or **v2-related work**: base your PR on `main`
15+
- For **v1 bug fixes** or **patches**: base your PR on `v1.x`
16+
517
## Getting Started
618

19+
This project uses [pnpm](https://pnpm.io/) as its package manager. If you don't have pnpm installed, enable it via [corepack](https://nodejs.org/api/corepack.html) (included with Node.js 16.9+):
20+
21+
```bash
22+
corepack enable
23+
```
24+
25+
Then:
26+
727
1. Fork the repository
828
2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/typescript-sdk.git`
9-
3. Install dependencies: `npm install`
10-
4. Build the project: `npm run build`
11-
5. Run tests: `npm test`
29+
3. Install dependencies: `pnpm install`
30+
4. Build the project: `pnpm build:all`
31+
5. Run tests: `pnpm test:all`
1232

1333
## Development Process
1434

15-
1. Create a new branch for your changes
35+
1. Create a new branch for your changes (based on `main` or `v1.x` as appropriate)
1636
2. Make your changes
17-
3. Run `npm run lint` to ensure code style compliance
18-
4. Run `npm test` to verify all tests pass
37+
3. Run `pnpm lint:all` to ensure code style compliance
38+
4. Run `pnpm test:all` to verify all tests pass
1939
5. Submit a pull request
2040

2141
## Pull Request Guidelines
@@ -28,8 +48,17 @@ We welcome contributions to the Model Context Protocol TypeScript SDK! This docu
2848

2949
## Running Examples
3050

31-
- Start the server: `npm run server`
32-
- Run the client: `npm run client`
51+
See [`examples/server/README.md`](examples/server/README.md) and [`examples/client/README.md`](examples/client/README.md) for a full list of runnable examples.
52+
53+
Quick start:
54+
55+
```bash
56+
# Run a server example
57+
pnpm --filter @modelcontextprotocol/examples-server exec tsx src/simpleStreamableHttp.ts
58+
59+
# Run a client example (in another terminal)
60+
pnpm --filter @modelcontextprotocol/examples-client exec tsx src/simpleStreamableHttp.ts
61+
```
3362

3463
## Code of Conduct
3564

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# MCP TypeScript SDK
22

3-
![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%server) ![NPM Version](https://img.shields.io/npm/v/%40modelcontextprotocol%client) ![MIT licensed](https://img.shields.io/npm/l/%40modelcontextprotocol%server)
3+
> [!IMPORTANT]
4+
> **This is the `main` branch which contains v2 of the SDK (currently in development, pre-alpha).**
5+
>
6+
> 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.
7+
>
8+
> For v1 documentation and code, see the [`v1.x` branch](https://github.com/modelcontextprotocol/typescript-sdk/tree/v1.x).
9+
10+
![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)
411

512
<details>
613
<summary>Table of Contents</summary>

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
},
3434
"devDependencies": {
3535
"@cfworker/json-schema": "catalog:runtimeShared",
36+
"@changesets/changelog-github": "^0.5.2",
3637
"@changesets/cli": "^2.29.8",
3738
"@eslint/js": "catalog:devTools",
3839
"@types/content-type": "catalog:devTools",

packages/server/src/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
export * from './server/completable.js';
2-
export * from './server/inMemoryEventStore.js';
32
export * from './server/mcp.js';
43
export * from './server/middleware/hostHeaderValidation.js';
54
export * from './server/server.js';

packages/server/src/server/inMemoryEventStore.ts

Lines changed: 0 additions & 79 deletions
This file was deleted.

pnpm-lock.yaml

Lines changed: 66 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)