You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+37-8Lines changed: 37 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,20 +2,40 @@
2
2
3
3
We welcome contributions to the Model Context Protocol TypeScript SDK! This document outlines the process for contributing to the project.
4
4
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
+
5
17
## Getting Started
6
18
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
+
7
27
1. Fork the repository
8
28
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`
12
32
13
33
## Development Process
14
34
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)
16
36
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
19
39
5. Submit a pull request
20
40
21
41
## Pull Request Guidelines
@@ -28,8 +48,17 @@ We welcome contributions to the Model Context Protocol TypeScript SDK! This docu
28
48
29
49
## Running Examples
30
50
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.
> **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).
0 commit comments