From a1569c6260f53ac405d378b60eb3bbf179193793 Mon Sep 17 00:00:00 2001
From: Justin Spahr-Summers <justin@anthropic.com>
Date: Mon, 11 Nov 2024 10:21:49 +0000
Subject: [PATCH 1/3] Add license information and more package metadata
---
LICENSE | 7 +++++++
package.json | 4 ++++
2 files changed, 11 insertions(+)
create mode 100644 LICENSE
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 00000000..596ffeee
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,7 @@
+Copyright (c) 2024 Anthropic, PBC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/package.json b/package.json
index d561dd99..7f13bff3 100644
--- a/package.json
+++ b/package.json
@@ -2,6 +2,10 @@
"name": "@modelcontextprotocol/sdk",
"version": "0.3.3",
"description": "Model Context Protocol implementation for TypeScript",
+ "license": "MIT",
+ "author": "Anthropic, PBC (https://anthropic.com)",
+ "homepage": "https://modelcontextprotocol.github.io",
+ "bugs": "https://github.com/modelcontextprotocol/typescript-sdk/issues",
"type": "module",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
From 65d092f17666d80426f2f08bc343ef3b3653e385 Mon Sep 17 00:00:00 2001
From: Justin Spahr-Summers <justin@anthropic.com>
Date: Mon, 11 Nov 2024 10:27:40 +0000
Subject: [PATCH 2/3] Proper README, based on the Python SDK's
---
README.md | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 109 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index a9371ba8..0f2d8331 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,110 @@
# mcp-typescript
-TypeScript implementation of the Model Context Protocol
+
+TypeScript implementation of the Model Context Protocol (MCP), providing both client and server capabilities for integrating with LLM surfaces.
+
+## Overview
+
+The Model Context Protocol allows applications to provide context for LLMs in a standardized way, separating the concerns of providing context from the actual LLM interaction. This TypeScript SDK implements the full MCP specification, making it easy to:
+
+- Build MCP clients that can connect to any MCP server
+- Create MCP servers that expose resources, prompts and tools
+- Use standard transports like stdio, SSE, and WebSocket
+- Handle all MCP protocol messages and lifecycle events
+
+## Installation
+
+```bash
+npm install @modelcontextprotocol/sdk
+```
+
+## Quick Start
+
+### Creating a Client
+
+```typescript
+import { Client } from "@modelcontextprotocol/sdk/client";
+import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio";
+
+const transport = new StdioClientTransport({
+ command: "path/to/server",
+});
+
+const client = new Client({
+ name: "example-client",
+ version: "1.0.0",
+});
+
+await client.connect(transport);
+
+// List available resources
+const resources = await client.request(
+ { method: "resources/list" },
+ ListResourcesResultSchema
+);
+
+// Read a specific resource
+const resourceContent = await client.request(
+ {
+ method: "resources/read",
+ params: {
+ uri: "file:///example.txt"
+ }
+ },
+ ReadResourceResultSchema
+);
+```
+
+### Creating a Server
+
+```typescript
+import { Server } from "@modelcontextprotocol/sdk/server";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio";
+
+const server = new Server({
+ name: "example-server",
+ version: "1.0.0",
+});
+
+server.setRequestHandler(ListResourcesRequestSchema, async () => {
+ return {
+ resources: [
+ {
+ uri: "file:///example.txt",
+ name: "Example Resource",
+ },
+ ],
+ };
+});
+
+server.setRequestHandler(ReadResourceRequestSchema, async (request) => {
+ if (request.params.uri === "file:///example.txt") {
+ return {
+ contents: [
+ {
+ uri: "file:///example.txt",
+ mimeType: "text/plain",
+ text: "This is the content of the example resource.",
+ },
+ ],
+ };
+ } else {
+ throw new Error("Resource not found");
+ }
+});
+
+const transport = new StdioServerTransport();
+await server.connect(transport);
+```
+
+## Documentation
+
+- [MCP Specification](https://modelcontextprotocol.github.io)
+- [Example Servers](https://github.com/modelcontextprotocol/example-servers)
+
+## Contributing
+
+Issues and pull requests are welcome on GitHub at https://github.com/modelcontextprotocol/typescript-sdk.
+
+## License
+
+This project is licensed under the MIT License—see the [LICENSE](LICENSE) file for details.
From abafc46072d625e4ac2c8fdf35970c86ea2c0927 Mon Sep 17 00:00:00 2001
From: Justin Spahr-Summers <justin@anthropic.com>
Date: Mon, 11 Nov 2024 10:28:13 +0000
Subject: [PATCH 3/3] Remove mention of WebSocket
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 0f2d8331..2664515f 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ The Model Context Protocol allows applications to provide context for LLMs in a
- Build MCP clients that can connect to any MCP server
- Create MCP servers that expose resources, prompts and tools
-- Use standard transports like stdio, SSE, and WebSocket
+- Use standard transports like stdio and SSE
- Handle all MCP protocol messages and lifecycle events
## Installation