Model Context Protocol TypeScript SDK 安装与配置指南

Model Context Protocol TypeScript SDK 安装与配置指南

typescript-sdk The official Typescript SDK for Model Context Protocol servers and clients 项目地址: https://gitcode.com/gh_mirrors/ty/typescript-sdk

1. 项目基础介绍

Model Context Protocol (MCP) TypeScript SDK 是一个开源项目，旨在为开发者提供一种标准化的方式来构建与大型语言模型（LLM）交互的服务器和客户端。它允许应用以安全、标准化的方式向 LLM 应用程序提供上下文信息，从而分离上下文提供和 LLM 实际交互的职责。

该项目主要使用 TypeScript 编程语言，它是 JavaScript 的一个超集，添加了静态类型选项。TypeScript 提供了更好的代码组织和类型检查，使代码更加健壮和易于维护。

2. 关键技术和框架

• TypeScript: 作为项目的编程语言，提供了类型安全性和先进的编程特性。
• Model Context Protocol (MCP): 核心协议，定义了服务器和客户端之间交互的标准方式。
• Zod: 用于验证和解析传入参数的类型。
• Express: 在 HTTP 服务器模式下，用于创建和管理的 Web 应用程序框架。

3. 安装和配置准备工作

在开始安装之前，请确保您的开发环境中已经安装以下工具：

• Node.js: 运行 TypeScript 代码的 JavaScript 运行时环境。
• npm: Node.js 包管理器，用于管理项目的依赖。

详细安装步骤

1. 克隆项目到本地：

   git clone https://github.com/modelcontextprotocol/typescript-sdk.git
   cd typescript-sdk
   

2. 安装项目依赖：

   npm install
   

3. 编译 TypeScript 代码到 JavaScript：

   npm run build
   

4. 根据您的需求配置 SDK。以下是一个简单的服务器配置示例：

   import { McpServer } from "@modelcontextprotocol/sdk/server/mcp";
   import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio";
   
   const server = new McpServer({
     name: "Example",
     version: "1.0.0",
   });
   
   // 添加资源和工具，例如：
   server.resource("example", "example://resource", async (uri) => {
     return {
       contents: [
         { uri: uri.href, text: "这是一个示例资源" },
       ],
     };
   });
   
   server.tool("exampleTool", { param: z.string() }, async ({ param }) => {
     return {
       content: [
         { type: "text", text: `工具输出: ${param}` },
       ],
     };
   });
   
   // 使用标准输入输出作为传输媒介
   const transport = new StdioServerTransport();
   await server.connect(transport);
   

5. 运行您的服务器：

   如果您使用的是上面的示例代码，可以通过 Node.js 运行它：

   node dist/example-server.js
   

   请确保将 dist/example-server.js 替换为您实际保存服务器代码的文件路径。

完成以上步骤后，您的 MCP TypeScript SDK 应该已经安装并配置成功，可以开始进行进一步的开发工作了。

typescript-sdk The official Typescript SDK for Model Context Protocol servers and clients 项目地址: https://gitcode.com/gh_mirrors/ty/typescript-sdk