chore: enter alpha prerelease mode (#1823)
This commit is contained in:
parent
81e4b2a412
commit
0fabc27742
2 changed files with 68 additions and 0 deletions
20
packages/client/README.md
Normal file
20
packages/client/README.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
# `@modelcontextprotocol/client`
|
||||
|
||||
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.
|
||||
|
||||
> [!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
|
||||
|
||||
```bash
|
||||
npm install @modelcontextprotocol/client@alpha
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- **[Repository README](https://github.com/modelcontextprotocol/typescript-sdk#readme)** — overview, package layout, examples
|
||||
- **[Client guide](https://github.com/modelcontextprotocol/typescript-sdk/blob/main/docs/client.md)**
|
||||
- **[API reference](https://ts.sdk.modelcontextprotocol.io/v2/)**
|
||||
- **[MCP specification](https://modelcontextprotocol.io)**
|
||||
23
packages/server/README.md
Normal file
23
packages/server/README.md
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# `@modelcontextprotocol/server`
|
||||
|
||||
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.
|
||||
|
||||
> [!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
|
||||
|
||||
```bash
|
||||
npm install @modelcontextprotocol/server@alpha
|
||||
```
|
||||
|
||||
Optional framework adapters: [`@modelcontextprotocol/express`](https://www.npmjs.com/package/@modelcontextprotocol/express), [`@modelcontextprotocol/hono`](https://www.npmjs.com/package/@modelcontextprotocol/hono),
|
||||
[`@modelcontextprotocol/node`](https://www.npmjs.com/package/@modelcontextprotocol/node).
|
||||
|
||||
## Documentation
|
||||
|
||||
- **[Repository README](https://github.com/modelcontextprotocol/typescript-sdk#readme)** — overview, package layout, examples
|
||||
- **[Server guide](https://github.com/modelcontextprotocol/typescript-sdk/blob/main/docs/server.md)**
|
||||
- **[API reference](https://ts.sdk.modelcontextprotocol.io/v2/)**
|
||||
- **[MCP specification](https://modelcontextprotocol.io)**
|
||||
Loading…
Reference in a new issue