diff --git a/.changeset/pre.json b/.changeset/pre.json new file mode 100644 index 000000000..cc0e96b6d --- /dev/null +++ b/.changeset/pre.json @@ -0,0 +1,25 @@ +{ + "mode": "pre", + "tag": "alpha", + "initialVersions": { + "@modelcontextprotocol/eslint-config": "2.0.0", + "@modelcontextprotocol/tsconfig": "2.0.0", + "@modelcontextprotocol/vitest-config": "2.0.0", + "@modelcontextprotocol/examples-client": "2.0.0-alpha.0", + "@modelcontextprotocol/examples-client-quickstart": "2.0.0-alpha.0", + "@modelcontextprotocol/examples-server": "2.0.0-alpha.0", + "@modelcontextprotocol/examples-server-quickstart": "2.0.0-alpha.0", + "@modelcontextprotocol/examples-shared": "2.0.0-alpha.0", + "@modelcontextprotocol/client": "2.0.0-alpha.0", + "@modelcontextprotocol/core": "2.0.0-alpha.0", + "@modelcontextprotocol/express": "2.0.0-alpha.0", + "@modelcontextprotocol/fastify": "2.0.0-alpha.0", + "@modelcontextprotocol/hono": "2.0.0-alpha.0", + "@modelcontextprotocol/node": "2.0.0-alpha.0", + "@modelcontextprotocol/server": "2.0.0-alpha.0", + "@modelcontextprotocol/test-conformance": "2.0.0-alpha.0", + "@modelcontextprotocol/test-helpers": "2.0.0-alpha.0", + "@modelcontextprotocol/test-integration": "2.0.0-alpha.0" + }, + "changesets": [] +} diff --git a/packages/client/README.md b/packages/client/README.md new file mode 100644 index 000000000..33ba09c2e --- /dev/null +++ b/packages/client/README.md @@ -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)** diff --git a/packages/server/README.md b/packages/server/README.md new file mode 100644 index 000000000..6ad42bc03 --- /dev/null +++ b/packages/server/README.md @@ -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)**