Github Gists

🚀 MCP TypeScript SDK

The TypeScript implementation of the Model Context Protocol (MCP) offers comprehensive client - side and server - side functionality, facilitating seamless integration with the interaction interfaces of large language models (LLMs).

🚀 Quick Start

Creating a Client

import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";

const transport = new StdioClientTransport({
  command: "path/to/server",
});

const client = new Client({
  name: "example-client",
  version: "1.0.0",
}, {
  capabilities: {}
});

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

import { Server } from "@modelcontextprotocol/sdk/server/index.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";

const server = new Server({
  name: "example-server",
  version: "1.0.0",
}, {
  capabilities: {
    resources: {}
  }
});

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);

✨ Features

The Model Context Protocol enables applications to provide context information to LLMs in a standardized manner, decoupling context provision from actual LLM interactions. This TypeScript SDK fully implements the MCP standard specification, making it easy to:

• Build clients that can connect to any MCP server.
• Create MCP servers that expose resources, prompts, and tools.
• Use standard transport methods such as stdio and SSE.
• Handle all MCP protocol messages and lifecycle events.

📦 Installation

npm install @modelcontextprotocol/sdk

📚 Documentation

• Official Documentation of Model Context Protocol
• MCP Specification
• Example Servers

💪 Contribution

Issues and pull requests are welcome on GitHub: https://github.com/modelcontextprotocol/typescript-sdk

📄 License

This project is licensed under the MIT License. For detailed information, please refer to the LICENSE file.